ShaderNodeEnvironment¶

class ShaderNodeEnvironment

An environment texture, like a cubemap.

Hierarchy

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

Members

string

ModeV

RW

The texture wrap mode in U, can be "w" for wrap or "c" for clamp

---

Inherited from class ShaderNodeTexture

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

nil

buildtexture

( )

Enqueue a texture build job

---

Inherited from class Locator

MeshPlug-compound

Geometry

-

The real time geometry to be displayed

---

Inherited from class ShaderNodeFileIn

string

Filename

RW

The texture filename

---

Inherited from class SceneGraphNode

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.
nil	Material	RW	The dependency on the connected Material
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
nil	_Gizmo	RW	The gizmos connected to this node Plug (self, "_Gizmos", Plug.NoSerial)
types.table	_TagSet	R	The full set of tags this node has, containing explicitly defined and inherited tags

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	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 nodes in the hierarchy that have at least one of the given tags
{SceneGraphNode} result	listbytags	( string|{string} tags )	List children nodes (include self) that have specified tags
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
nil	traverserender	( table traversal , ... ... )	Traverse the hierarchy with a traversal object

nil	displayrenderattribute	( string category , string name , bool show )	Enable/disable the display of a specific attribute in the properties
table attribute	getrenderattributedefinition	( string category , string name )	Lookup the render attributes definition by for a category and aan attribute name
nil	listrenderattributes	( )	Get the list of available render attributes
nil	setrenderattributeproperty	( string category , string name , string property , any value )	Set a render attribute property

---

Inherited from class ShaderNode

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

ShaderNode result	addnode	( string filename )	add a node into a shader node by its filename
ShaderNodeIn input	createinput	( string name , type type )	Create a new input
ShaderNodeOut input	createoutput	( string name )	Create a new output
nil	fillnodefooter	( table template )	Fill the template footer with custom attributes
nil	fillnodeinputstemplate	( table template )	Fill the template with inputs and ouputs extended controls
nil	fillnodetemplate	( table template )	Fill the template with custom attributes
nil	fillnodetemplatefooter	( table template )	Fill the template with standard node template footer, like inputs and outputs settings
nil	fillnodetemplateheader	( table template )	Fill the template with standard node template header, like inputs
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
nil	removeinput	( string name )	Remove an input
nil	removeoutput	( string name )	Remove an output

---

Inherited from class HostNode

types.string

HostPath

RW

The data archive to read HostPlugs value when baked

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

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

string

Name

RW

The node name

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
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 )	load a file content in this 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 )	Paste a string copy into 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

string ModeV RW

The texture wrap mode in U, can be "w" for wrap or "c" for clamp

---