API Search || Global Search
HPS::MaterialPaletteDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::MaterialPaletteDefinition:
HPS::Definition HPS::Object

Public Member Functions

 MaterialPaletteDefinition ()
 
 MaterialPaletteDefinition (Definition const &in_that)
 
 MaterialPaletteDefinition (MaterialPaletteDefinition const &in_that)
 
 MaterialPaletteDefinition (MaterialPaletteDefinition &&in_that)
 
HPS::Type ObjectType () const
 
MaterialPaletteDefinitionoperator= (MaterialPaletteDefinition const &in_that)
 
MaterialPaletteDefinitionoperator= (MaterialPaletteDefinition &&in_that)
 
void Set (MaterialKitArray const &in_source)
 
void Set (size_t in_count, MaterialKit const in_source[])
 
void Show (MaterialKitArray &out_source) const
 
- Public Member Functions inherited from HPS::Definition
virtual void Assign (Definition const &in_that)
 
 Definition ()
 
 Definition (Definition const &in_that)
 
 Definition (Definition &&in_that)
 
bool Equals (Definition const &in_that) const
 
UTF8 Name () const
 
bool operator!= (Definition const &in_that) const
 
Definitionoperator= (Definition const &in_that)
 
Definitionoperator= (Definition &&in_that)
 
bool operator== (Definition const &in_that) const
 
PortfolioKey Owner () const
 
void Undefine ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::MaterialPaletteDefinition
 
- Static Public Attributes inherited from HPS::Definition
static const HPS::Type staticType = HPS::Type::Definition
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The MaterialPaletteDefinition class is a smart pointer to a database object. It is a handle to a material palette defined within a portfolio.

Constructor & Destructor Documentation

HPS::MaterialPaletteDefinition::MaterialPaletteDefinition ( )

The default constructor creates an uninitialized MaterialPaletteDefinition object. The Type() function will return Type::None.

HPS::MaterialPaletteDefinition::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_thatThe source Definition to copy.
HPS::MaterialPaletteDefinition::MaterialPaletteDefinition ( MaterialPaletteDefinition const &  in_that)

The copy constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source MaterialPaletteDefinition.

Parameters
in_thatThe source MaterialPaletteDefinition to copy.
HPS::MaterialPaletteDefinition::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_thatAn rvalue reference to a MaterialPaletteDefinition to take the impl from.

Member Function Documentation

MaterialPaletteDefinition& HPS::MaterialPaletteDefinition::operator= ( MaterialPaletteDefinition const &  in_that)

Associate this MaterialPaletteDefinition with the same underlying impl as the source MaterialPaletteDefinition.

Parameters
in_thatThe source MaterialPaletteDefinition for the assignment.
Returns
A reference to this MaterialPaletteDefinition.
MaterialPaletteDefinition& HPS::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_thatAn rvalue reference to a MaterialPaletteDefinition to take the impl from.
Returns
A reference to this MaterialPaletteDefinition.
void HPS::MaterialPaletteDefinition::Set ( MaterialKitArray const &  in_source)

Redefine the material array for this MaterialPaletteDefinition.

Parameters
in_sourceThe new array of materials for this MaterialPaletteDefinition.
void HPS::MaterialPaletteDefinition::Set ( size_t  in_count,
MaterialKit const  in_source[] 
)

Redefine the material array for this MaterialPaletteDefinition.

Parameters
in_countSize of the following array.
in_sourceThe new array of materials for this MaterialPaletteDefinition.
void HPS::MaterialPaletteDefinition::Show ( MaterialKitArray out_source) const

Shows the material array for this MaterialPaletteDefinition.

Parameters
out_sourceThe array of materials for this MaterialPaletteDefinition.

The documentation for this class was generated from the following file: