TargetPrimitiveΒΆ

class TargetPrimitive

This class is the base for objects that can aim at a given position

Hierarchy

class TargetPrimitive < class Locator < class SceneGraphNode < class HostNode < class SelectableNode < class Node

Children classes : class CameraBase , class Light , class Portal , class ShaderNodeGizmo

Members

Methods:

point3 direction getdirection ( ) Returns the direction to target
number distance gettargetdistance ( ) Returns the target distance in local space
point3 target gettargetposition ( ) Returns the position of the target in local space
point3 target gettargetworldposition ( ) Returns the target position in world space
point3 up getup ( ) Returns the node up vector
point3 direction getworlddirection ( ) Returns the direction to target in world space
matrix t getworldmatrixorient ( ) Returns the local to world matrix of this node oriented on the Z axis according to the DirectionMode plug.
matrix t getworldtolocalmatrixorient ( ) Returns the world to local matrix of this node oriented on the Z axis according to the DirectionMode plug.
transform t getworldtransformorient ( ) Returns the local to world transform of this node oriented on the Z axis according to the DirectionMode plug.
point3 up getworldup ( ) Returns the node up vector
nil setworldpositiontargetup ( point3|nil position , point3|nil target , point3|nil up ) Sets the world position, target and up vector of the node

Inherited from class Locator

Plugs:

MeshPlug-compound Geometry - The real time geometry to be displayed

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:

nil createinstance ( SceneGraphNode instance ) Create an instance at this node
nil fillanimationtemplate ( table template ) Fill a template table with the "Animation" attributes
nil fillarealighttemplate ( table template ) Fill a template table with the "Area Light" attributes
nil fillcurvestemplate ( table template ) Fill a template table with the "Curves" attributes
nil fillgeometrytemplate ( table template ) Fill a template table with the "Geometry" attributes
nil filllinkingtemplate ( table template ) Fill a template table with the "Linking" attributes
nil fillopengltemplate ( table template ) Fill a template table with the "OpenGL" attributes
nil fillparticlestemplate ( table template ) Fill a template table with the "Particles" attributes
nil fillproceduraltemplate ( table template ) Fill a template table with the "Procedural" attributes
nil fillraytracingtemplate ( table template ) Fill a template table with the "Raytracing" attributes
nil fillsamplingtemplate ( table template ) Fill a template table with the "Sampling" attributes
nil fillscenenodetemplate ( table template ) Fill a template table with the "Primitive" attributes
nil fillshadertemplate ( table template ) Fill a template table with the "Surface" attributes
nil fillshadingtemplate ( table template ) Fill a template table with the "Shading" attributes
nil fillsubdivtemplate ( table template ) Fill a template table with the "Subdivision" attributes
nil filltransformtemplate ( table template ) Fill a template table with the "Transform" attributes
nil fillvolumetrictemplate ( table template ) Fill a template table with the "Volumetric" attributes
nil flatteninstance ( string|nil name ) Flatten an instance by name, or all instances if name is nil
matrix m getmatrix ( ) Returns the node's first transform matrix.
matrix pm getparentworldmatrix ( ) Returns the exclusive world matrix of the node
transform pt getparentworldtransform ( ) Returns the exclusive world transform of the node
point3 p getposition ( ) Returns the node's position.
SceneGraphNode parent getsgparent ( ) Returns the node's hierarchical parent.
Node node gettransform ( ) Return the top Transform node of the transform stack of this SceneGraphNode or this if the stack is empty
matrix m getworldmatrix ( ) Returns the node's world transform first matrix.
point3 p getworldposition ( ) Returns the node's world position.
matrix im getworldtolocalmatrix ( ) Returns the inverse of the world matrix
transform it getworldtolocaltransform ( ) Returns the inverse of the world transform
transform t getworldtransform ( ) Returns the node's world transform.
nil isinstance ( string path ) Returns true if the given path contains an instance
nil isleafinstance ( string path ) Returns true if the lath item of the path is an instance
{SceneGraphNode} result listbytags ( string|{string} tags ) List children nodes (include self) that have specified tags
{SceneGraphNode} result listbytags ( string|{string} tags ) List nodes in the hierarchy that have at least one of the given tags
result Node pathtonode ( string path ) Returns a node from a path, this path may be dynamically generated by RenderGraph instancing
result Node realpathtonode ( string path ) Returns a node from a path, this path must be static
nil removeinstance ( The path ) Remove an instance
nil setmatrix ( matrix m ) Set the local matrix of the node
nil setworldmatrix ( matrix world ) Set the world matrix of the node
nil setworldposition ( point3 position ) Set the world position of the node, leaving the rest of the transform unchanged
nil traverse ( function map , ... ... ) Traverse the hierarchy and call a map function on every node

Functions:

nil displayrenderattribute ( string category , string name , bool show ) Enable/disable the display of a specific attribute in the properties
string parentpath getparentpath ( string path ) Get the parent path of a path
table attribute getrenderattributedefinition ( string category , string name ) Lookup the render attributes definition by for a category and aan attribute name
table attributes getrenderattributes ( string|Node path , boolean full ) Get the rendering attributes of a node/path
nil listrenderattributes ( ) Get the list of available render attributes
transform world pathlocaltransformorient ( string path ) Get the world to local transform a node/path with its local z axis transform applied (lights and cameras can have their z flipped)
transform world pathworldtransform ( string path ) Get the local to world transform a node/path
transform world pathworldtransformorient ( string path ) Get the local to world transform a node/path with its local z axis transform applied (lights and cameras can have their z flipped)
nil setrenderattributeproperty ( string category , string name , string property , any value ) Set a render attribute property

Inherited from class HostNode

Plugs:

types.string HostPath RW The data archive to read HostPlugs value when baked

Methods:

nil deleteinheritedattr ( string plugname ) Delete an inherited attribute plug from the node
nil overrideinheritedattr ( string plugname , any value ) Override the attribute
nil setinheritedattr ( string plugname , [bool|nil] inherited , [ any value ] ) 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.

Inherited from class Node

Plugs:

string Name RW The node name

Methods:

bool result belongstoreference ( Reference ref ) Tells if the node belongs to the reference, or a sub reference
nil delete ( ) Delete a node
any value eval ( Plug plug ) Called by the framework when plug (a node's plug) must be evaluated
Node|Plug child findchild ( string path ) Find a child node or plug using a path
Node parent findparent ( string name ) Find the first parent Node of this Node of a specific class
Node result getchild ( string name ) Get a child node by its name
[string|number] name getname ( ) Get the Node name in its parent
Node parent getparent ( ) Get the parent Node of this Node
string path getpath ( ) Returns the node path as a string that can be reused with findchild
Reference reference getreference ( ) Returns the reference node it is connected to
of table getreferences ( [ topref Reference ] ) Returns the references in the document sorted depth first.
string result getstringcopy ( ) Return a copy of the node and its content as a string to be pasted
Reference reference gettopreference ( ) Returns the top reference node it is connected to
boolean editable iseditable ( ) Indicates if the node can be edited by the user in the UI
boolean indocument isindocument ( ) Tells if the node is inside a document, or is pending in the void
bool result ismoveable ( ) Tells if the node can be moved
boolean result isparent ( Node child ) Tells if this node is parent of the potential child
boolean result isreference ( ) Tells if a node comes from a reference project
boolean state isselected ( ) Tell if the node is selected
{Node} result loadfile ( string filename , [ table options ] ) load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node.
Node result loadtemplate ( string template , string name ) load a template file
nil move ( Node parent ) Move a node to a new parent
nil onpathchanged ( ) Called by the framework when the name of this node or of one of its parent is modified
{Node},string result,error pastestringcopy ( string copy , [ {} options ] ) Paste a string copy into this node
ReferenceBase refnode referencefile ( string name , string refpath , [ table options ] ) reference a file content in this node.
nil rename ( string name ) Rename a node
bool,string success,error savefile ( string filename ) load a node to a file
nil seteditable ( boolean editable ) Change the editable state of the node
nil setflags ( ) Set the node flags

Documentation

point3 direction getdirection ( )

Returns the direction to target

Return:

  • direction The target direction

number distance gettargetdistance ( )

Returns the target distance in local space

Return:

  • distance The target distance

point3 target gettargetposition ( )

Returns the position of the target in local space

Return:

  • target The target position

point3 target gettargetworldposition ( )

Returns the target position in world space

Return:

  • target The target position

point3 up getup ( )

Returns the node up vector

Return:

  • up The up vector

point3 direction getworlddirection ( )

Returns the direction to target in world space

Return:

  • direction The target direction

matrix t getworldmatrixorient ( )

Returns the local to world matrix of this node oriented on the Z axis according to the DirectionMode plug.

Return:

  • t The Z oriented node matrix

matrix t getworldtolocalmatrixorient ( )

Returns the world to local matrix of this node oriented on the Z axis according to the DirectionMode plug.

Return:

  • t The Z oriented node matrix

transform t getworldtransformorient ( )

Returns the local to world transform of this node oriented on the Z axis according to the DirectionMode plug.

Return:

  • t The Z oriented node transform

point3 up getworldup ( )

Returns the node up vector

Return:

  • up The up vector

nil setworldpositiontargetup ( point3|nil position , point3|nil target , point3|nil up )

Sets the world position, target and up vector of the node

Arguments:

  • position the new world position or nil if left unchanged
  • target the new world target or nil if left unchanged
  • up the new world up vector or nil if left unchanged