MaterialPaletteDefinition

class HPS.MaterialPaletteDefinition : 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

override void Dispose ()

MaterialPaletteDefinition ()

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

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.

Param in_that:The source Definition to copy.

MaterialPaletteDefinition (HPS.MaterialPaletteDefinition in_that)

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

Param in_that:The source MaterialPaletteDefinition to copy.

override HPS.Type ObjectType ()

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).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.MaterialKit[] in_source)

Redefine the material array for this MaterialPaletteDefinition.

Param in_source:  The new array of materials for this MaterialPaletteDefinition.

void Show (out HPS.MaterialKit[] out_source)

Shows the material array for this MaterialPaletteDefinition.

Param out_source:  The array of materials for this MaterialPaletteDefinition.