CameraBaseΒΆ

class CameraBase

This class is a base for all viewing cameras

Hierarchy

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

Children classes : class Camera

Members

Plugs:

types.string CamType RW The camera type, only for system cameras
nil CameraParams - An invalidation message for any of the camera position, size and rendering attribute
types.float Far RW Far clipping plane distance
types.float Fov RW The camera field of view angle, in degrees
types.enum FrameMode RW The display mode for the camera gate frame, "none", "wireframe" or "filled"
types.float{min=0, FrameOpacity max=1} RW The camera gate frame opacity
types.float FrameRatio RW The camera frame ratio
types.string Icon RW The camera icon
types.float Near RW Near clipping plane distance
types.float OrthoScale RW Scale factor for an ortographic camera
types.bool Perspective RW True if the camera is a perspective camera, false if the camera is orthographic
types.float RenderFov RW The actual camera field of view angle used for rendering, in degrees
types.enum RenderMode RW The camera rendering mode, "wireframe", "filled"
types.string RenderName RW The name of the camera used in place of $e in layers
nil RenderPassCamera - A connection plug to the Pass nodes (such as RenderPasses)
types.float _FocalLengthFactor RW Horizontal focal length scale factor, generally used to adjust overscan for 3d rendering

Methods:

table frustum evalfrustum ( ) Evaluate the camera frustum vertices in world space

Inherited from class TargetPrimitive

Methods:

point3 target gettargetposition ( ) Returns the position of the target in local space
number distance gettargetdistance ( ) Returns the target distance in local space
point3 direction getdirection ( ) Returns the direction to target
point3 up getup ( ) Returns the node up vector
point3 target gettargetworldposition ( ) Returns the target position in world space
point3 direction getworlddirection ( ) Returns the direction to target in world space
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
transform t getworldtransformorient ( ) Returns the local to world transform 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.
matrix t getworldmatrixorient ( ) Returns the local to world matrix of this node oriented on the Z axis according to the DirectionMode plug.

Inherited from class Locator

Plugs:

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

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 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

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

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 setinheritedattr ( string plugname , [bool|nil] inherited , [ any value ] ) Set the inheritance status of the attribute
nil overrideinheritedattr ( string plugname , any value ) Override 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:

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 ) 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

Documentation

types.string CamType RW

The camera type, only for system cameras

nil CameraParams -

An invalidation message for any of the camera position, size and rendering attribute

types.float Far RW

Far clipping plane distance

types.float Fov RW

The camera field of view angle, in degrees

types.enum FrameMode RW

The display mode for the camera gate frame, "none", "wireframe" or "filled"

types.float{min=0, FrameOpacity max=1}

RW The camera gate frame opacity

types.float FrameRatio RW

The camera frame ratio

types.string Icon RW

The camera icon

types.float Near RW

Near clipping plane distance

types.float OrthoScale RW

Scale factor for an ortographic camera

types.bool Perspective RW

True if the camera is a perspective camera, false if the camera is orthographic

types.float RenderFov RW

The actual camera field of view angle used for rendering, in degrees

types.enum RenderMode RW

The camera rendering mode, "wireframe", "filled"

types.string RenderName RW

The name of the camera used in place of $e in layers

nil RenderPassCamera -

A connection plug to the Pass nodes (such as RenderPasses)

types.float _FocalLengthFactor RW

Horizontal focal length scale factor, generally used to adjust overscan for 3d rendering

table frustum evalfrustum ( )

Evaluate the camera frustum vertices in world space

Evaluate the camera frustum as an array of vertices, in world space, corresponding to { {left,bottom,near}, {right,bottom,near}, {left,top,near}, {right,top,near}, {left,bottom,far}, {right,bottom,far}, {left,top,far}, {right,top,far} }
Return:

  • frustum