ScenePyΒΆ
class ScenePy
Hierarchy
class ScenePy < class PyScript < class Scene < class Script < class SceneGraphNode < class Node < class HostNode < class SelectableNode
Members
Inherited from class PyScript
Plugs:
string | Script | R | The Lua script event handler to execute |
Inherited from class Scene
Functions:
| getparam | (
|
Inherited from class SceneGraphNode
Plugs:
types.bool | FreezeTransform | RW | Indicate if the SceneGraphNode's parameters are to be frozen |
boolean | Hidden | RW | The visibility state. |
types.enum | HierarchyMode | RW | Indicates the transform mode of the node (local, world as PRMan, Maya or Max) |
nil | Instances | RW | The dpendencies on instanced SceneGraphNodes |
nil | InvWBounds | R | Invalidated when the world transform and/or bounds of the object has changed. |
boolean | IsHidden | R | The visibility state. This plug tells if this node is visible, regarding its state and the state of its parents. |
types.string | Mermbership | RW | The list of tags the node owns |
nil | RibAttributes | RW | The dependency on the additional Rib Attributes to be assigned |
transform | Transform | RW | The SceneGraphNode's local to world transform |
types.table | _TagSet | R | The full set of tags this node has, containing explicitly defined and inherited tags |
Methods:
| createinstance | (
|
Create an instance at this node |
| fillanimationtemplate | (
|
Fill a template table with the "Animation" attributes |
| fillarealighttemplate | (
|
Fill a template table with the "Area Light" attributes |
| fillcurvestemplate | (
|
Fill a template table with the "Curves" attributes |
| fillgeometrytemplate | (
|
Fill a template table with the "Geometry" attributes |
| filllinkingtemplate | (
|
Fill a template table with the "Linking" attributes |
| fillopengltemplate | (
|
Fill a template table with the "OpenGL" attributes |
| fillparticlestemplate | (
|
Fill a template table with the "Particles" attributes |
| fillproceduraltemplate | (
|
Fill a template table with the "Procedural" attributes |
| fillraytracingtemplate | (
|
Fill a template table with the "Raytracing" attributes |
| fillsamplingtemplate | (
|
Fill a template table with the "Sampling" attributes |
| fillscenenodetemplate | (
|
Fill a template table with the "Primitive" attributes |
| fillshadertemplate | (
|
Fill a template table with the "Surface" attributes |
| fillshadingtemplate | (
|
Fill a template table with the "Shading" attributes |
| fillsubdivtemplate | (
|
Fill a template table with the "Subdivision" attributes |
| filltransformtemplate | (
|
Fill a template table with the "Transform" attributes |
| fillvolumetrictemplate | (
|
Fill a template table with the "Volumetric" attributes |
| flatteninstance | (
|
Flatten an instance by name, or all instances if name is nil |
| getmatrix | ( ) | Returns the node's first transform matrix. |
| getparentworldmatrix | ( ) | Returns the exclusive world matrix of the node |
| getparentworldtransform | ( ) | Returns the exclusive world transform of the node |
| getposition | ( ) | Returns the node's position. |
| getsgparent | ( ) | Returns the node's hierarchical parent. |
| gettransform | ( ) | Return the top Transform node of the transform stack of this SceneGraphNode or this if the stack is empty |
| getworldmatrix | ( ) | Returns the node's world transform first matrix. |
| getworldposition | ( ) | Returns the node's world position. |
| getworldtolocalmatrix | ( ) | Returns the inverse of the world matrix |
| getworldtolocaltransform | ( ) | Returns the inverse of the world transform |
| getworldtransform | ( ) | Returns the node's world transform. |
| isinstance | (
|
Returns true if the given path contains an instance |
| isleafinstance | (
|
Returns true if the lath item of the path is an instance |
| listbytags | (
|
List children nodes (include self) that have specified tags |
| listbytags | (
|
List nodes in the hierarchy that have at least one of the given tags |
| pathtonode | (
|
Returns a node from a path, this path may be dynamically generated by RenderGraph instancing |
| realpathtonode | (
|
Returns a node from a path, this path must be static |
| removeinstance | (
|
Remove an instance |
| setmatrix | (
|
Set the local matrix of the node |
| setworldmatrix | (
|
Set the world matrix of the node |
| setworldposition | (
|
Set the world position of the node, leaving the rest of the transform unchanged |
| traverse | (
|
Traverse the hierarchy and call a map function on every node |
Functions:
| displayrenderattribute | (
|
Enable/disable the display of a specific attribute in the properties |
| getparentpath | (
|
Get the parent path of a path |
| getrenderattributedefinition | (
|
Lookup the render attributes definition by for a category and aan attribute name |
| getrenderattributes | (
|
Get the rendering attributes of a node/path |
| listrenderattributes | ( ) | Get the list of available render attributes |
| pathlocaltransformorient | (
|
Get the world to local transform a node/path with its local z axis transform applied (lights and cameras can have their z flipped) |
| pathworldtransform | (
|
Get the local to world transform a node/path |
| pathworldtransformorient | (
|
Get the local to world transform a node/path with its local z axis transform applied (lights and cameras can have their z flipped) |
| setrenderattributeproperty | (
|
Set a render attribute property |
Inherited from class Node
Plugs:
string | Name | RW | The node name |
Methods:
| belongstoreference | (
|
Tells if the node belongs to the reference, or a sub reference |
| delete | ( ) | Delete a node |
| eval | (
|
Called by the framework when plug (a node's plug) must be evaluated |
| findchild | (
|
Find a child node or plug using a path |
| findparent | (
|
Find the first parent Node of this Node of a specific class |
| getchild | (
|
Get a child node by its name |
| getname | ( ) | Get the Node name in its parent |
| getparent | ( ) | Get the parent Node of this Node |
| getpath | ( ) | Returns the node path as a string that can be reused with findchild |
| getreference | ( ) | Returns the reference node it is connected to |
| getreferences | (
[
|
Returns the references in the document sorted depth first. |
| getstringcopy | ( ) | Return a copy of the node and its content as a string to be pasted |
| gettopreference | ( ) | Returns the top reference node it is connected to |
| iseditable | ( ) | Indicates if the node can be edited by the user in the UI |
| isindocument | ( ) | Tells if the node is inside a document, or is pending in the void |
| ismoveable | ( ) | Tells if the node can be moved |
| isparent | (
|
Tells if this node is parent of the potential child |
| isreference | ( ) | Tells if a node comes from a reference project |
| isselected | ( ) | Tell if the node is selected |
| loadfile | (
|
load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node. |
| loadtemplate | (
|
load a template file |
| move | (
|
Move a node to a new parent |
| onpathchanged | ( ) | Called by the framework when the name of this node or of one of its parent is modified |
| pastestringcopy | (
|
Paste a string copy into this node |
| referencefile | (
|
reference a file content in this node. |
| rename | (
|
Rename a node |
| savefile | (
|
load a node to a file |
| seteditable | (
|
Change the editable state of the node |
| setflags | ( ) | Set the node flags |
Inherited from class HostNode
Plugs:
types.string | HostPath | RW | The data archive to read HostPlugs value when baked |
Methods:
| deleteinheritedattr | (
|
Delete an inherited attribute plug from the node |
| overrideinheritedattr | (
|
Override the attribute |
| setinheritedattr | (
|
Set the inheritance status of the attribute |
Inherited from class SelectableNode
Plugs:
boolean | Selected | R | True if the node is selected. Don't use this plug directly to select a node, use the Document's modifier select method. |