ShaderParamDefOptions Class
Reference
#include <xsi_shaderparamdefoptions.h>
Represents the advanced options for a shader parameter definition (ShaderParamDef) object.
This object provides a convenient way to specify certain characteristics for each shader parameter definition (for example, display name, default values, capabilities, etc.). You can use the same ShaderParamDefOptions object for multiple parameters, changing only the display name (and any other characteristics you need to).
The Factory::CreateShaderParamDefOptions function creates a new ShaderParamDefOptions object which you need to pass to the ShaderParamDefContainer::AddParamDef or ShaderParamDefContainer::AddArrayParamDef when adding parameter definitions.
Public Member Functions |
|
| ShaderParamDefOptions () | |
| ~ShaderParamDefOptions () | |
| ShaderParamDefOptions (const CRef &in_ref) | |
| ShaderParamDefOptions (const ShaderParamDefOptions &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| ShaderParamDefOptions & | operator= (const ShaderParamDefOptions &in_obj) |
| ShaderParamDefOptions & | operator= (const CRef &in_ref) |
| CStatus | SetAnimatable (bool in_v) |
| CStatus | SetDefaultValue (const CValue &in_v) |
| CStatus | SetHardLimit (const CValue &in_vMin, const CValue &in_vMax) |
| CStatus | SetInspectable (bool in_v) |
| CStatus | SetLongName (const CString &in_str) |
| CStatus | SetShortName (const CString &in_str) |
| CStatus | SetSoftLimit (const CValue &in_vMin, const CValue &in_vMax) |
| CStatus | SetTexturable (bool in_v) |
| CStatus | SetAttribute (const CString &in_name, const CValue &in_value) |
| CStatus | SetReadOnly (bool in_v) |
Default constructor.
Default destructor.
| ShaderParamDefOptions | ( | const CRef & | in_ref | ) |
Constructor.
| in_ref | constant reference object. |
| ShaderParamDefOptions | ( | const ShaderParamDefOptions & | in_obj | ) |
Copy constructor.
| in_obj | constant class object. |
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from SIObject.
| siClassID GetClassID | ( | ) | const [virtual] |
| ShaderParamDefOptions& operator= | ( | const ShaderParamDefOptions & | in_obj | ) |
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
| in_obj | constant class object. |
| ShaderParamDefOptions& operator= | ( | const CRef & | in_ref | ) |
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
| in_ref | constant class object. |
Reimplemented from SIObject.
| CStatus SetAnimatable | ( | bool | in_v | ) |
Sets whether or not this shader parameter can be animated.
| in_v | true if animatable |
Sets the default value for this parameter definition. This defines the value that will be set on the instantiated ShaderParameter (Parameter::GetDefault).
| in_v | Default value to use. |
Sets the minimum and maximum values for this parameter definition. This defines the valid value range when instantiated (Parameter::GetMin and Parameter::GetMax).
| in_vMin | Minimum allowable value. |
| in_vMax | Maximum allowable value. |
| CStatus SetInspectable | ( | bool | in_v | ) |
Sets whether or not this parameter definition will appear on the property page associated with the instantiated Shader.
| in_v | true if inspectable (will appear on the property page). |
Sets the a user-friendly version of the parameter name that will appear in the UI. This is the value that the Parameter::GetScriptName function returns on the instance (ShaderParameter).
| in_str | parameter name to be displayed in the UI (either on the shader node or on the associated property page). |
Sets the short version of the parameter name (the
ShaderParamDef::GetDisplayName). This is the name that appears
in the Scene Explorer (with the View > Use Script
Names option turned OFF). It is also the same
value that SIObject::GetName
returns on the instance (ShaderParameter).
| in_str | The DisplayName as it will appear in the Scene
Explorer |
Sets the suggested minimum and maximum values for this parameter definition. This defines the value range that is displayed in the property page when instantiated (Parameter::GetSuggestedMin and Parameter::GetSuggestedMax).
| in_vMin | Minimum suggested value. |
| in_vMax | Maximum suggested value. |
| CStatus SetTexturable | ( | bool | in_v | ) |
Sets whether or not this parameter definition will be a shader node port when instantiated (supports being connected to a rendering node).
| in_v | true if texturable. |
Sets an attribute by name. The attribute can be named anything and can contain any value. A list of attributes that Softimage understands can be found in siShaderParameterAttribute.
| in_name | Name of the attribute to set. Can be one of the
siShaderParameterAttribute string constants or a string that you
define, such as "version". |
| in_value | Value to set. This could be one of the Softimage shader string constants (siShaderReferenceFilterType, siShaderPropertyFilterType, siShaderCustomDataType), or a custom value. |
| CStatus SetReadOnly | ( | bool | in_v | ) |
Sets the ReadOnly capability.
| in_v | true if texturable. |