Package autodesk_toxik :: Module graph :: Class GraphRO

Class GraphRO

 object --+    
          |    
Boost.Python.instance --+
              |
             GraphRO

Known Subclasses:

Graph

Provides read-only access to the internals of a composition version (composition graph). Superclass of Graph.

Instance Methods

__cmp__(...)

__init__(...)
Raises an exception This class cannot be instantiated from Python

__reduce__(...)
helper for pickle

int

getComponents(...)
Returns: The number of components in the images of the primary output node (if no outputName argument is specified) or of the named output node.

Composition

getComposition(...)
Returns: The Composition this Graph belongs to.

int

getDepth(...)
Returns: The bit depth of each channel of the image for the primary output node (if no outputName argument is specified) or the named output node.

str

getDescription(...)
Returns: The description str (comment) of the version.

int

getDuration(...)
Returns: Number of frames (int) in the primary output node or the named output node.

int

getEnd(...)
Returns: The end time index of the primary output node or the named output node.

[str]

getExternalDependencies(...)
Returns: The external dependencies of the composition version as a list of absolute paths (str) to the external files.

str

getFileFormat(...)
Returns: The name of the image file format that will be used to produce images when rendering (e.g.: exr, tga, ...)

str

getFileFormatOptions(...)
Returns: File format options (in the form of an XML string) for the file format specified with 'getFileFormat'

str

getFileName(...)
Returns: File format options (in the form of an XML string) for the file format specified with 'getFileFormat'

int

getHeight(...)
Returns: Height of the images produced by the primary output node (if no output name argument is specified), or the named output node.

str

getId(...)
Returns: The version uuid string.

tuple

getImageRatio(...)
Returns: The image ratio (width/height ratio taking the pixel ratio into account) as a (numerator, denominator) tuple (2 integers) for the primary output node or a named output node.

int

getMarkIn(...)
Returns: The composition version mark in.

int

getMarkOut(...)
Returns: The composition version mark out.

str

getName(...)
Returns: The name of this version (str).

str

getPaintStrokesFolder(...)
Returns: The absolute path (str) to the folder containing paint strokes files for the composition version.

str

getPath(...)
Returns: The path of this version.

tuple

getPixelRatio(...)
Returns: The pixel aspect ratio of the image for the primary output node (if no outputName argument is specified) or the named output node, as a (numerator, denominator) tuple.

tuple

getRate(...)
Returns: The frame rate of the primary output node (if no outputName argument is specified) or the named output node, as a (numerator, denominator) integer tuple.

bool

getRenderEnabled(...)
Returns: True if rendering is enabled on the primary output node or the named output node.

RepeatMode

getRepeatMode(...)
Returns: The composition version repeat mode as a module-level RepeatMode class enumeration member.

str

getRole(...)
Returns: The role (str) of the composition version.

str

getSource(...)
Returns: The source of the composition version.

int

getStart(...)
Returns: The start time index of the primary output node or the named output node.

int

getWidth(...)
Returns: Width of the images produced by the primary output node (if no outputName argument is specified), or the named output node.

str

getWiretapClipName(...)
Returns: Pattern for the wiretap clip name (i.e.

bool

getWiretapEnabled(...)
Returns: Boolean indicating whether rendering will export to wiretap.

str

getWiretapPath(...)
Returns: Path where the wiretap clip will be created when rendering.

bool

isReadOnly(...)
Returns: True if the graph is read-only.

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

getComponents(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: int

The number of components in the images of the primary output node (if no outputName argument is specified) or of the named output node.

getComposition(...)

Returns: Composition: The Composition this Graph belongs to.

getDepth(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: int

The bit depth of each channel of the image for the primary output node (if no outputName argument is specified) or the named output node.

getDescription(...)

Returns: str: The description str (comment) of the version.

getDuration(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: int

Number of frames (int) in the primary output node or the named output node.

getEnd(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: int

The end time index of the primary output node or the named output node.

getExternalDependencies(...)

Parameters:

depTypes (int) - This argument is a combination of external dependency types (integer mask built from a binary OR of graph.ExternalDepType values) which defaults to graph.ExternalDepType.ALL_TYPES.

Returns: [str]

The external dependencies of the composition version as a list of absolute paths (str) to the external files.

getFileFormat(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: str

The name of the image file format that will be used to produce images when rendering (e.g.: exr, tga, ...)

getFileFormatOptions(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: str

File format options (in the form of an XML string) for the file format specified with 'getFileFormat'

getFileName(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: str

File format options (in the form of an XML string) for the file format specified with 'getFileFormat'

getHeight(...)

Parameters:

outputName (str) - Optional string specifying the output name.

Returns: int

Height of the images produced by the primary output node (if no output name argument is specified), or the named output node.

getId(...)

Returns: str: The version uuid string.

getImageRatio(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: tuple

The image ratio (width/height ratio taking the pixel ratio into account) as a (numerator, denominator) tuple (2 integers) for the primary output node or a named output node.

getMarkIn(...)

Returns: int: The composition version mark in.

getMarkOut(...)

Returns: int: The composition version mark out.

getName(...)

Returns: str: The name of this version (str).

getPaintStrokesFolder(...)

Returns: str: The absolute path (str) to the folder containing paint strokes files for the composition version.

getPath(...)

Returns: str: The path of this version.

getPixelRatio(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: tuple

The pixel aspect ratio of the image for the primary output node (if no outputName argument is specified) or the named output node, as a (numerator, denominator) tuple.

getRate(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: tuple

The frame rate of the primary output node (if no outputName argument is specified) or the named output node, as a (numerator, denominator) integer tuple.

getRenderEnabled(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: bool

True if rendering is enabled on the primary output node or the named output node.

getRepeatMode(...)

Returns: RepeatMode: The composition version repeat mode as a module-level RepeatMode class enumeration member.

getRole(...)

Returns: str: The role (str) of the composition version.

See Also: setRole()

getSource(...)

Returns: str: The source of the composition version.

See Also: setSource()

getStart(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: int

The start time index of the primary output node or the named output node.

getWidth(...)

Parameters:

outputName (str) - Optional string specifying the output name.

Returns: int

Width of the images produced by the primary output node (if no outputName argument is specified), or the named output node.

getWiretapClipName(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: str

Pattern for the wiretap clip name (i.e. including substitutions) that will be produced when rendering. Only used if wiretap is enabled for this output.

getWiretapEnabled(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: bool

Boolean indicating whether rendering will export to wiretap.

getWiretapPath(...)

Parameters:

outputName (str) - Optional argument specifying the output name.

Returns: str

Path where the wiretap clip will be created when rendering. Only used if wiretap is enabled for this output.

isReadOnly(...)

Returns: bool: True if the graph is read-only.

Class GraphRO

__init__(...) (Constructor)

__reduce__(...)

getComponents(...)

getComposition(...)

getDepth(...)

getDescription(...)

getDuration(...)

getEnd(...)

getExternalDependencies(...)

getFileFormat(...)

getFileFormatOptions(...)

getFileName(...)

getHeight(...)

getId(...)

getImageRatio(...)

getMarkIn(...)

getMarkOut(...)

getName(...)

getPaintStrokesFolder(...)

getPath(...)

getPixelRatio(...)

getRate(...)

getRenderEnabled(...)

getRepeatMode(...)

getRole(...)

getSource(...)

getStart(...)

getWidth(...)

getWiretapClipName(...)

getWiretapEnabled(...)

getWiretapPath(...)

isReadOnly(...)

init(...)
(Constructor)

reduce(...)