rfm2  22.0
A python-based rewrite of RenderMan for Maya
 All Classes Namespaces Files Functions Variables Pages
rfm2.utils.node_desc.NodeDescParam Class Reference
+ Inheritance diagram for rfm2.utils.node_desc.NodeDescParam:
+ Collaboration diagram for rfm2.utils.node_desc.NodeDescParam:

Public Member Functions

def __init__
 
def name
 
def name
 
def get_help
 
def is_array
 
def finalize
 
def cond_vis_trigger_params
 
def parse_vis_ops
 
def __str__
 
def __repr__
 

Public Attributes

 type
 
 default
 
 has_ui_struct
 
 connectable
 
 help
 
 triggerParams
 

Static Public Attributes

list staticCondVisAttributes
 
list dynCondVisAttributes = ['%sOp', '%sPath', '%sValue']
 

Detailed Description

A base class for parameter descriptions. It has only 2 mandatory attributes:
name and type. Defaults, array and ui configuration attributes are all
optional.

Attributes:
    name (str): the parameter's name
    type (TYPE): the parameter's data type

Constructor & Destructor Documentation

def rfm2.utils.node_desc.NodeDescParam.__init__ (   self)

Member Function Documentation

def rfm2.utils.node_desc.NodeDescParam.__repr__ (   self)

+ Here is the call graph for this function:

def rfm2.utils.node_desc.NodeDescParam.__str__ (   self)
Encodes the data in a human-readable form.
Used for serialisation.

Returns:
    str: A readble version of the object's contents.

+ Here is the call graph for this function:

def rfm2.utils.node_desc.NodeDescParam.cond_vis_trigger_params (   self)
def rfm2.utils.node_desc.NodeDescParam.finalize (   self)
Post-process the description data:
- make some attribute types non-connectable (int, matrix)
- escapes some characters for maya consumption.
- processes conditional visibility.

Returns:
    None
def rfm2.utils.node_desc.NodeDescParam.get_help (   self)
Returns the help string or a minimal parameter description (type and
name) if not available.
NOTE: the help string may have been re-formated during description
parsing.

Returns:
    str: The help string.

+ Here is the call graph for this function:

def rfm2.utils.node_desc.NodeDescParam.is_array (   self)
def rfm2.utils.node_desc.NodeDescParam.name (   self)

+ Here is the caller graph for this function:

def rfm2.utils.node_desc.NodeDescParam.name (   self,
  value 
)
attributes can take the form 'visibility:camera'. This is not a legal
maya name, so we adopt the old rfm format for backward compatibility.

+ Here is the call graph for this function:

def rfm2.utils.node_desc.NodeDescParam.parse_vis_ops (   self)
Limited (non-recursive) implementation of conditional visibility
parsing for katana-style hintdict.
FIXME: regex keyword not implemented.

Member Data Documentation

rfm2.utils.node_desc.NodeDescParam.connectable
rfm2.utils.node_desc.NodeDescParam.default
list rfm2.utils.node_desc.NodeDescParam.dynCondVisAttributes = ['%sOp', '%sPath', '%sValue']
static
rfm2.utils.node_desc.NodeDescParam.has_ui_struct
rfm2.utils.node_desc.NodeDescParam.help
list rfm2.utils.node_desc.NodeDescParam.staticCondVisAttributes
static
Initial value:
1 = ['conditionalVisPath', 'conditionalVisValue',
2  'conditionalVisLeft', 'conditionalVisRight']
rfm2.utils.node_desc.NodeDescParam.triggerParams
rfm2.utils.node_desc.NodeDescParam.type

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