Package nuke :: Class LiveGroup

[frames] | no frames]

Class LiveGroup

object --+            
         |            
 nuke.Node --+        
             |        
    nuke.Group --+    
                 |    
      nuke.Precomp --+
                     |
                    nuke.LiveGroup

Instance Methods

__getitem__(x, y)
x[y]

__len__(x)
len(x)

__repr__(x)
repr(x)

__str__(x)
str(x)

bool

anyOverrides()
If any of the exposed link knobs are overridden it returns with True.

bool

applyOverrides()
This function only affects link knobs that are placed on a LiveGroup type node.

bool

isLocal()
Checks if the LiveGroup is local.WARNING: This function is deprecated.

None

makeEditable()
Puts the LiveGroup into "editable" state.

None

makeLocal()
Puts the LiveGroup into "local" state.

bool

modified()
Returns True if the anything within the livegroup has changed.

bool

publish(file)
Writes a LiveGroup to a file.

bool

published()
Returns True if the LiveGroup is published.

bool

revertOverrides()
This function only affects link knobs that are placed on a LiveGroup type node.

Inherited from Precomp: reload

Inherited from Group: __enter__, __exit__, __reduce_ex__, begin, connectSelectedNodes, end, expand, node, nodes, numNodes, output, run, selectedNode, selectedNodes, splaySelectedNodes

Inherited from Node: Class, __new__, addCallback, addKnob, allKnobs, autoplace, bbox, canSetInput, channels, clearCallbacks, clones, connectInput, deepSample, deepSampleCount, dependencies, dependent, error, executePythonCallback, fileDependencies, firstFrame, forceUpdateLocalization, forceValidate, format, frameRange, fullName, getNumKnobs, hasError, height, help, hideControlPanel, input, inputs, isLocalizationOutdated, isLocalized, isSelected, knob, knobs, lastFrame, linkableKnobs, localizationProgress, lock, locked, maxInputs, maxOutputs, maximumInputs, maximumOutputs, metadata, minInputs, minimumInputs, name, numKnobs, opHashes, optionalInput, performanceInfo, pixelAspect, proxy, readKnobs, redraw, removeCallback, removeKnob, resetKnobsToDefault, rootNode, running, sample, screenHeight, screenWidth, selectOnly, setInput, setName, setSelected, setTab, setXYpos, setXpos, setYpos, showControlPanel, showInfo, shown, treeHasError, unlock, upstreamFrameRange, width, writeKnobs, xpos, ypos

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __setattr__, __sizeof__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

getitem(x, y)
(Indexing operator)

x[y]

Overrides: Node.__getitem__

len(x)
(Length operator)

len(x)

Overrides: Node.__len__

repr(x)
(Representation operator)

repr(x)

Overrides: object.__repr__

str(x)
(Informal representation operator)

str(x)

Overrides: object.__str__

applyOverrides()

This function only affects link knobs that are placed on a LiveGroup type node. It replaces the value of the linked knob in the live group with the value set in the LiveGroup node.

Returns: bool

isLocal()

Checks if the LiveGroup is local.WARNING: This function is deprecated. Use published() instead.

Returns: bool

makeLocal()

Puts the LiveGroup into "local" state. WARNING: This function is deprecated. Use makeEditable() instead.

Returns: None

publish(file)

Writes a LiveGroup to a file.

Parameters:

file - (optional) The path to which we want to publish this LiveGroup. If None then write to the path currently defined by the file knob. If the file specified by this param already exists, Nuke will attempt to over write it without a warning. Otherwise a new file will be created.

Returns: bool

bool. True if successful, else, False.

revertOverrides()

This function only affects link knobs that are placed on a LiveGroup type node. When called the LinkKnob will revert to the linked knob value and will follow it after reloads.

Returns: bool