ShaderballOptions Class
Reference
#include <xsi_shaderballoptions.h>
Represents the options for a shaderball view.
This object represents the options available to tweak the initial appearance of the shaderball node/window in the RenderTree. You can access this object via ShaderDef::GetShaderballOptions.
Public Member Functions |
|
| ShaderballOptions () | |
| ~ShaderballOptions () | |
| ShaderballOptions (const CRef &in_ref) | |
| ShaderballOptions (const ShaderballOptions &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| ShaderballOptions & | operator= (const ShaderballOptions &in_obj) |
| ShaderballOptions & | operator= (const CRef &in_ref) |
| CString | GetDefaultBackground () const |
| CStatus | PutDefaultBackground (const CString &in_background) |
| CString | GetDefaultModel () const |
| CStatus | PutDefaultModel (const CString &in_model) |
| siShaderballDimension | GetDimension () const |
| CStatus | PutDimension (siShaderballDimension in_dimension) |
| bool | GetInit () const |
| CStatus | Reset () |
| bool | GetShowByDefault () const |
| CStatus | PutShowByDefault (bool in_show) |
Default constructor.
| ~ShaderballOptions | ( | ) |
Default destructor.
| ShaderballOptions | ( | const CRef & | in_ref | ) |
Constructor.
| in_ref | constant reference object. |
| ShaderballOptions | ( | const ShaderballOptions & | 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] |
| ShaderballOptions& operator= | ( | const ShaderballOptions & | 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. |
| ShaderballOptions& 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.
| CString GetDefaultBackground | ( | ) | const |
Returns the background to use by default.
Sets the background to use.
| in_background | the shaderball background name. |
| CString GetDefaultModel | ( | ) | const |
Returns the model to use for the shaderball by default.
Sets the model to use for the shaderball by default.
| in_model | the name of the model |
| siShaderballDimension GetDimension | ( | ) | const |
Returns one of the siShaderballDimension enum values that determines what dimensions the shaderball supports.
| CStatus PutDimension | ( | siShaderballDimension | in_dimension | ) |
Sets one of the siShaderballDimension enum values that determines what dimensions the shaderball supports.
| in_dimension | supported dimension |
| bool GetInit | ( | ) | const |
Indicates whether or not the shaderball was initialized.
| CStatus Reset | ( | ) |
Returns the shaderball options to the uninitialized state.
| bool GetShowByDefault | ( | ) | const |
Returns a Boolean value describing whether or not to show the shaderball by default.
| CStatus PutShowByDefault | ( | bool | in_show | ) |
Sets a Boolean value describing whether or not to show the shaderball by default.
| in_show | true to show the shaderball by default; false otherwise |