MayaImagePlaneΒΆ

class MayaImagePlane

This node displays a bitmap on a 3d plane, it can be linked to the camera

The MayaImagePlane class inherit from Locator to be displayed in the scene and from ShaderNodeTexture to be able to load/compile a texture

Hierarchy

class MayaImagePlane < class Locator < class ShaderNodeTexture < class SceneGraphNode < class ShaderNodeFileIn < class HostNode < class ShaderNode < class SelectableNode < class Node

Members

Plugs:

RW AlphaGain The Texture alpha gain
nil CamParams - Camera parameters have changed
RW ColorGain The Texture color gain
RW ColorOffset The Texture color offset
types.enum DisplayMode RW Render mode of the plane
types.float Distance RW The distance of the MayaImagePlane to the parent camera
types.enum Fit RW Fit texture to "Fill", "Best", "Horizontal", "Vertical", or "To Size"
types.enum FitTo RW Fit plane to "Resolution Gate", "Film Gate", or "Custom"
types.bool InAllCams RW Plane is visible in all cameras
types.vector2 Size RW The plane aperture, in inches

Inherited from class Locator

Plugs:

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

Inherited from class ShaderNodeTexture

Plugs:

float Width RW The texture lookup blur factor
float Blur RW The texture lookup blur absolute value
float AlphaMul RW The RGB component are premultiplied by alpha
float Samples RW The number of texel filtered per texture lookup
nil LayerTexture RW The output layer connected to the texture

Methods:

nil buildtexture ( ) Enqueue a texture build job

Inherited from class SceneGraphNode

Plugs:

transform Transform RW The SceneGraphNode's local to world transform
types.enum HierarchyMode RW Indicates the transform mode of the node (local, world as PRMan, Maya or Max)
types.bool FreezeTransform RW Indicate if the SceneGraphNode's parameters are to be frozen
nil InvWBounds R Invalidated when the world transform and/or bounds of the object has changed.
boolean Hidden RW The visibility state.
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
types.table _TagSet R The full set of tags this node has, containing explicitly defined and inherited tags
nil RibAttributes RW The dependency on the additional Rib Attributes to be assigned
nil Instances RW The dpendencies on instanced SceneGraphNodes

Methods:

{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
SceneGraphNode parent getsgparent ( ) Returns the node's hierarchical parent.
matrix m getmatrix ( ) Returns the node's first transform matrix.
point3 p getposition ( ) Returns the node's position.
transform t getworldtransform ( ) Returns the node's world transform.
matrix m getworldmatrix ( ) Returns the node's world transform first matrix.
point3 p getworldposition ( ) Returns the node's world position.
transform it getworldtolocaltransform ( ) Returns the inverse of the world transform
matrix im getworldtolocalmatrix ( ) Returns the inverse of the world matrix
transform pt getparentworldtransform ( ) Returns the exclusive world transform of the node
matrix pm getparentworldmatrix ( ) Returns the exclusive world 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 setmatrix ( matrix m ) Set the local matrix of the node
nil traverse ( function map , ... ... ) Traverse the hierarchy and call a map function on every node
Node node gettransform ( ) Return the top Transform node of the transform stack of this SceneGraphNode or this if the stack is empty
nil filltransformtemplate ( table template ) Fill a template table with the "Transform" attributes
nil fillscenenodetemplate ( table template ) Fill a template table with the "Primitive" attributes
nil fillproceduraltemplate ( table template ) Fill a template table with the "Procedural" attributes
nil fillgeometrytemplate ( table template ) Fill a template table with the "Geometry" attributes
nil fillsubdivtemplate ( table template ) Fill a template table with the "Subdivision" attributes
nil fillopengltemplate ( table template ) Fill a template table with the "OpenGL" attributes
nil filllinkingtemplate ( table template ) Fill a template table with the "Linking" attributes
nil fillarealighttemplate ( table template ) Fill a template table with the "Area Light" attributes
nil fillraytracingtemplate ( table template ) Fill a template table with the "Raytracing" 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 fillsamplingtemplate ( table template ) Fill a template table with the "Sampling" attributes
nil fillanimationtemplate ( table template ) Fill a template table with the "Animation" attributes
nil fillvolumetrictemplate ( table template ) Fill a template table with the "Volumetric" attributes
nil fillcurvestemplate ( table template ) Fill a template table with the "Curves" attributes
nil fillparticlestemplate ( table template ) Fill a template table with the "Particles" attributes
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
nil createinstance ( SceneGraphNode instance ) Create an instance at this node
nil removeinstance ( The path ) Remove an instance
nil flatteninstance ( string|nil name ) Flatten an instance by name, or all instances if name is nil
result Node realpathtonode ( string path ) Returns a node from a path, this path must be static
result Node pathtonode ( string path ) Returns a node from a path, this path may be dynamically generated by RenderGraph instancing

Functions:

nil listrenderattributes ( ) Get the list of available render attributes
table attribute getrenderattributedefinition ( string category , string name ) Lookup the render attributes definition by for a category and aan attribute name
nil setrenderattributeproperty ( string category , string name , string property , any value ) Set a render attribute property
nil displayrenderattribute ( string category , string name , bool show ) Enable/disable the display of a specific attribute in the properties
table attributes getrenderattributes ( string|Node path , boolean full ) Get the rendering attributes of a node/path
transform world pathworldtransform ( string path ) Get the local to world transform a node/path
string parentpath getparentpath ( string path ) Get the parent path of a 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)
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)

Inherited from class ShaderNodeFileIn

Plugs:

string Filename RW The texture filename

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 ShaderNode

Plugs:

string Code RW The shader node default BOOTS code
string CodeRT RW The shader node BOOTS code specialized for OpenGL
{float,float} NodePos RW The shader node position in shader view
boolean Collapsed RW The shader node collapse state, true for collapsed, false for expanded

Methods:

ShaderNodeIn input getinput ( string name ) Gets a child ShaderNodeIn plug by its display name
ShaderNodeOut input getoutput ( string name ) Gets a child ShaderNodeOut plug by its display name
ShaderNodeIn input createinput ( string name , type type ) Create a new input
nil removeinput ( string name ) Remove an input
ShaderNodeOut input createoutput ( string name ) Create a new output
nil removeoutput ( string name ) Remove an output
ShaderNode result addnode ( string filename ) add a node into a shader node by its filename
nil fillnodetemplateheader ( table template ) Fill the template with standard node template header, like inputs
nil fillnodetemplatefooter ( table template ) Fill the template with standard node template footer, like inputs and outputs settings
nil fillnodetemplate ( table template ) Fill the template with custom attributes
nil fillnodefooter ( table template ) Fill the template footer with custom attributes
nil fillnodeinputstemplate ( table template ) Fill the template with inputs and ouputs extended controls
ShaderNodeIn aov addaov ( ) create a new aov

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:

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

Documentation

RW AlphaGain The

Texture alpha gain

nil CamParams -

Camera parameters have changed

RW ColorGain The

Texture color gain

RW ColorOffset The

Texture color offset

types.enum DisplayMode RW

Render mode of the plane

types.float Distance RW

The distance of the MayaImagePlane to the parent camera

types.enum Fit RW

Fit texture to "Fill", "Best", "Horizontal", "Vertical", or "To Size"

types.enum FitTo RW

Fit plane to "Resolution Gate", "Film Gate", or "Custom"

types.bool InAllCams RW

Plane is visible in all cameras

types.vector2 Size RW

The plane aperture, in inches