rfm2.utils.node_desc.NodeDesc Class Reference

Inheritance diagram for rfm2.utils.node_desc.NodeDesc:

Collaboration diagram for rfm2.utils.node_desc.NodeDesc:

Public Member Functions
def	__init__
def	name
def	name
def	ctlname
def	is_maya_node
def	get_param_desc
def	get_output_desc
def	get_attribute_desc
def	is_unique
def	__str__
def	__repr__

Public Attributes
	node_type
	rman_node_type
	params
	outputs
	attributes
	param_dict
	attribute_dict
	output_dict
	classification
	nodeid
	onCreate
	textured_params
	pages_condvis_dict
	pages_trigger_params
	ui_structs
	ui_struct_membership
	ouput_dict
	name
	help
	fileExtension

Detailed Description

A class that reads node descriptions from args or oso files.

Attributes:
- name (str): Surface, PxrBlackBody, etc.
- node_type (str): bxdf, pattern, light, etc.
- rman_node_type (str): usually name except for metashaders.
- params (list): list of NodeDescParam objects.
- outputs (list): list of NodeDescParam objects.
- attributes (list): list of NodeDescParam objects.
- classification (str): maya's node classification.
- nodeid (int): unique node identifier for maya. Can be none if not a maya \
node
- onCreate (list): callback to be executed on node creation.
- textured_params (list): names of textured params. Used by the texture \
manager.

Constructor & Destructor Documentation

def rfm2.utils.node_desc.NodeDesc.__init__	(		self,
			filepath
	)

Takes a file path to a file of a known format (args, OSL, JSON),
parses it and stores the data for later retrieval.

Arguments:
    filepath {FilePath} -- full path to args or oso file.

Member Function Documentation

def rfm2.utils.node_desc.NodeDesc.__repr__

(

self

)

def rfm2.utils.node_desc.NodeDesc.__str__

(

self

)

debugging method

Returns:
    str -- a human-readable dump of the node.

def rfm2.utils.node_desc.NodeDesc.ctlname

(

self

)

def rfm2.utils.node_desc.NodeDesc.get_attribute_desc	(		self,
			pname
	)

def rfm2.utils.node_desc.NodeDesc.get_output_desc	(		self,
			pname
	)

def rfm2.utils.node_desc.NodeDesc.get_param_desc	(		self,
			pname
	)

def rfm2.utils.node_desc.NodeDesc.is_maya_node

(

self

)

Return True if the node description has a valid node id. The node id
is used by Maya as a unique identifier for the node.

Returns:
    boolean: True if it can be instanced as a maya node.

def rfm2.utils.node_desc.NodeDesc.is_unique

(

self

)

Return True if there must be only one instance on this node type in
the scene.

Here is the call graph for this function:

def rfm2.utils.node_desc.NodeDesc.name

(

self

)

def rfm2.utils.node_desc.NodeDesc.name	(		self,
			value
	)

Member Data Documentation

rfm2.utils.node_desc.NodeDesc.attribute_dict

rfm2.utils.node_desc.NodeDesc.attributes

rfm2.utils.node_desc.NodeDesc.classification

rfm2.utils.node_desc.NodeDesc.fileExtension

rfm2.utils.node_desc.NodeDesc.help

rfm2.utils.node_desc.NodeDesc.name

rfm2.utils.node_desc.NodeDesc.node_type

rfm2.utils.node_desc.NodeDesc.nodeid

rfm2.utils.node_desc.NodeDesc.onCreate

rfm2.utils.node_desc.NodeDesc.ouput_dict

rfm2.utils.node_desc.NodeDesc.output_dict

rfm2.utils.node_desc.NodeDesc.outputs

rfm2.utils.node_desc.NodeDesc.pages_condvis_dict

rfm2.utils.node_desc.NodeDesc.pages_trigger_params

rfm2.utils.node_desc.NodeDesc.param_dict

rfm2.utils.node_desc.NodeDesc.params

rfm2.utils.node_desc.NodeDesc.rman_node_type

rfm2.utils.node_desc.NodeDesc.textured_params

rfm2.utils.node_desc.NodeDesc.ui_struct_membership

rfm2.utils.node_desc.NodeDesc.ui_structs

---

The documentation for this class was generated from the following file:

• /data/wlw/renderman_root/rat/apps/rfm/scripts/rfm2/utils/node_desc.py