MaterialPaletteDefinition
-
class
MaterialPaletteDefinition: public HPS::Definition The MaterialPaletteDefinition class is a smart pointer to a database object. It is a handle to a material palette defined within a portfolio.
Public Functions
-
MaterialPaletteDefinition() The default constructor creates an uninitialized MaterialPaletteDefinition object. The Type() function will return Type::None.
-
MaterialPaletteDefinition(Definition const &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.
Parameters: in_that – The source Definition to copy.
-
MaterialPaletteDefinition(MaterialPaletteDefinition &&in_that) The move constructor creates a MaterialPaletteDefinition by transferring the underlying impl of the rvalue reference to this MaterialPaletteDefinition thereby avoiding a copy and allocation.
Parameters: in_that – An rvalue reference to a MaterialPaletteDefinition to take the impl from.
-
MaterialPaletteDefinition(MaterialPaletteDefinition const &in_that) The copy constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source MaterialPaletteDefinition.
Parameters: in_that – The source MaterialPaletteDefinition to copy.
-
inline virtual HPS::Type
ObjectType() const This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
Returns: The declared type of the object in question, which may differ from the true, underlying type.
-
MaterialPaletteDefinition &
operator=(MaterialPaletteDefinition &&in_that) The move assignment operator transfers the underlying impl of the rvalue reference to this MaterialPaletteDefinition thereby avoiding a copy.
Parameters: in_that – An rvalue reference to a MaterialPaletteDefinition to take the impl from. Returns: A reference to this MaterialPaletteDefinition.
-
MaterialPaletteDefinition &
operator=(MaterialPaletteDefinition const &in_that) Associate this MaterialPaletteDefinition with the same underlying impl as the source MaterialPaletteDefinition.
Parameters: in_that – The source MaterialPaletteDefinition for the assignment. Returns: A reference to this MaterialPaletteDefinition.
-
void
Set(MaterialKitArray const &in_source) Redefine the material array for this MaterialPaletteDefinition.
Parameters: in_source – The new array of materials for this MaterialPaletteDefinition.
-
void
Set(size_t in_count, MaterialKit const in_source[]) Redefine the material array for this MaterialPaletteDefinition.
Parameters: - in_count – Size of the following array.
- in_source – The new array of materials for this MaterialPaletteDefinition.
-
void
Show(MaterialKitArray &out_source) const Shows the material array for this MaterialPaletteDefinition.
Parameters: out_source – The array of materials for this MaterialPaletteDefinition.
-
~MaterialPaletteDefinition()
-
