gear_mc
 All Classes Namespaces Functions Variables
Public Member Functions | Public Attributes | List of all members
gear.xsi.parameter.ParamDef2 Class Reference

Create a parameter definition using the AddParameter2 mapping. More...

Inheritance diagram for gear.xsi.parameter.ParamDef2:
gear.xsi.parameter.ParamDef

Public Member Functions

def __init__
 Init Method. More...
 
- Public Member Functions inherited from gear.xsi.parameter.ParamDef
def __init__
 Init Method. More...
 
def create
 Add a parameter to property using the parameter definition. More...
 
def getAsXml
 Return the xml definition of the parameterDef. More...
 
def setFromXml
 

Public Attributes

 scriptName
 
 valueType
 
 value
 
 minimum
 
 maximum
 
 sugMinimum
 
 sugMaximum
 
 classification
 
 capabilities
 
- Public Attributes inherited from gear.xsi.parameter.ParamDef
 scriptName
 
 value
 
 valueType
 
 minimum
 
 maximum
 
 sugMinimum
 
 sugMaximum
 
 classification
 
 capabilities
 

Detailed Description

Create a parameter definition using the AddParameter2 mapping.


I didn't implement the simple ParamDef class (only ParamDef2 and ParamDef3) beacuase this is some kind of obsolete method in Softimage SDK.

Constructor & Destructor Documentation

def gear.xsi.parameter.ParamDef2.__init__ (   self,
  scriptName,
  valueType,
  value,
  minimum = None,
  maximum = None,
  sugMinimum = None,
  sugMaximum = None,
  classification = c.siClassifUnknown,
  capabilities = c.siPersistable 
)

Init Method.

Parameters
self
scriptNameString - Parameter scriptname
valueTypeInteger - siVariantType
valueVariant - Default parameter value
minimumVariant - mininum value
maximumVariant - maximum value
sugMinimumVariant - suggested mininum value
sugMaximumVariant - suggested maximum value
classificationInteger - parameter classification
capabilitiesInteger - parameter capabilities
Returns
ParamDef - The stored parameter definition

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