class ShadingClampNode
ClampNode describes a single clamp shading node in a shading network. Input 1 is clamped per-component between Input 2 and 3.
Properties
| Property | Description |
|---|
| Name | The name of the ShadingClampNode object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetClass | Get the name of the ShadingClampNode class. (Inherited from Object) |
| GetDefaultParameterAlpha | The default parameter values. (Inherited from ShadingNode) |
| GetDefaultParameterBlue | The default parameter values. (Inherited from ShadingNode) |
| GetDefaultParameterGreen | The default parameter values. (Inherited from ShadingNode) |
| GetDefaultParameterRed | The default parameter values. (Inherited from ShadingNode) |
| GetInput | The default node inputs. (Inherited from ShadingFilterNode) |
| GetParameterCount | The input count. (Inherited from ShadingNode) |
| GetParameterIsInputable | Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input. (Inherited from ShadingFilterNode) |
| GetParameterName | The name of a parameter. (Inherited from ShadingNode) |
| IsA | Returns true if ShadingClampNode is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ShadingClampNode object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ShadingClampNode object is valid. (Inherited from Object) |
| NonNull | Returns true if the ShadingClampNode object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ShadingClampNode object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetDefaultParameter | The default parameter values. (Inherited from ShadingNode) |
| SetInput | The default node inputs. (Inherited from ShadingFilterNode) |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spShadingClampNode, and if this is the case, returns the object cast into spShadingClampNode. (Inherited from Object) |
Properties details
Name
The name of the ShadingClampNode object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetClass
Get the name of the ShadingClampNode class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetDefaultParameterAlpha
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterBlue
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterGreen
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterRed
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be fetched. |
Return value
Type: float
The default node inputs.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | input_id | | | The id of the input to be fetched. |
Return value
Type: ShadingNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | input_id | | | The id of the input to be fetched. |
Return value
Type: ShadingNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| input_id | int | | | The id of the input to be fetched. |
Return value
Type: ShadingNode
GetParameterCount
The input count.
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: int
Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | param_id | | | The id of the parameter to be checked. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | param_id | | | The id of the parameter to be checked. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| param_id | int | | | The id of the parameter to be checked. |
Return value
Type: bool
GetParameterName
The name of a parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to fetch the name of. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameter_id | | | The id of the input to fetch the name of. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to fetch the name of. |
Return value
Type: str
IsA
Returns true if ShadingClampNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ShadingClampNode is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if ShadingClampNode is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if ShadingClampNode is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ShadingClampNode object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the ShadingClampNode object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the ShadingClampNode object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the ShadingClampNode object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
SetDefaultParameter
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be set. |
real | r | | | The value of red to which the default input will be set. |
real | g | | | The value of green to which the default input will be set. |
real | b | | | The value of blue to which the default input will be set. |
real | a | | | The value of alpha to which the default input will be set. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameter_id | | | The id of the input to be set. |
float | r | | | The value of red to which the default input will be set. |
float | g | | | The value of green to which the default input will be set. |
float | b | | | The value of blue to which the default input will be set. |
float | a | | | The value of alpha to which the default input will be set. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameter_id | int | | | The id of the input to be set. |
| r | float | | | The value of red to which the default input will be set. |
| g | float | | | The value of green to which the default input will be set. |
| b | float | | | The value of blue to which the default input will be set. |
| a | float | | | The value of alpha to which the default input will be set. |
The default node inputs.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | input_id | | | The id of the input to be set. |
ShadingNode | input_node | | | The node to be set as input. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | input_id | | | The id of the input to be set. |
ShadingNode | input_node | | | The node to be set as input. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| input_id | int | | | The id of the input to be set. |
| input_node | ShadingNode | | | The node to be set as input. |
Return value
Type: bool
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spShadingClampNode, and if this is the case, returns the object cast into spShadingClampNode. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: ShadingClampNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: ShadingClampNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ShadingClampNode
