REFERENCE MANUAL
The MaterialPaletteDefinition class is a smart pointer to a database object. More...
Public Member Functions | |
override void | Dispose () |
MaterialPaletteDefinition () | |
The default constructor creates an uninitialized MaterialPaletteDefinition object. More... | |
MaterialPaletteDefinition (HPS.Definition in_that) | |
This constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source Definition. More... | |
MaterialPaletteDefinition (HPS.MaterialPaletteDefinition in_that) | |
This constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source Definition. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.MaterialKit[] in_source) |
Redefine the material array for this MaterialPaletteDefinition. More... | |
void | Show (out HPS.MaterialKit[] out_source) |
Shows the material array for this MaterialPaletteDefinition. More... | |
![]() | |
virtual void | Assign (HPS.Definition in_that) |
Associate this Definition with the same underlying impl as the source Definition. More... | |
Definition () | |
The default constructor creates an uninitialized Definition object. More... | |
Definition (HPS.Definition in_that) | |
The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Definition in_that) |
Check if the source Definition is equivalent to this Definition. More... | |
override int | GetHashCode () |
string | Name () |
Get the name given to this Definition when it was defined. More... | |
HPS.PortfolioKey | Owner () |
Get the portfolio that owns this Definition. More... | |
void | Undefine () |
Removes this definition from the owning portfolio. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Definition a, HPS.Definition b) |
static bool | operator== (HPS.Definition a, HPS.Definition b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The MaterialPaletteDefinition class is a smart pointer to a database object.
It is a handle to a material palette defined within a portfolio.
HPS.MaterialPaletteDefinition.MaterialPaletteDefinition | ( | ) |
The default constructor creates an uninitialized MaterialPaletteDefinition object.
The Type() function will return Type::None.
HPS.MaterialPaletteDefinition.MaterialPaletteDefinition | ( | HPS.Definition | in_that | ) |
This constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source Definition.
The copy will only be successful if the source definition is really an upcast of a material palette definition. Otherwise the copy will fail and the resulting MaterialPaletteDefinition will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy. |
HPS.MaterialPaletteDefinition.MaterialPaletteDefinition | ( | HPS.MaterialPaletteDefinition | in_that | ) |
This constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source Definition.
The copy will only be successful if the source definition is really an upcast of a material palette definition. Otherwise the copy will fail and the resulting MaterialPaletteDefinition will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Definition.
void HPS.MaterialPaletteDefinition.Set | ( | HPS.MaterialKit[] | in_source | ) |
Redefine the material array for this MaterialPaletteDefinition.
in_source | The new array of materials for this <ref refid="class_h_p_s_1_1_material_palette_definition" kindref="compound">MaterialPaletteDefinition</ref>. |
void HPS.MaterialPaletteDefinition.Show | ( | out HPS.MaterialKit[] | out_source | ) |
Shows the material array for this MaterialPaletteDefinition.
out_source | The array of materials for this <ref refid="class_h_p_s_1_1_material_palette_definition" kindref="compound">MaterialPaletteDefinition</ref>. |