HPS.MaterialPaletteDefinition Class Reference

Inheritance diagram for HPS.MaterialPaletteDefinition:

Public Member Functions
override void	Dispose ()
	MaterialPaletteDefinition ()
	MaterialPaletteDefinition (HPS.Definition in_that)
	MaterialPaletteDefinition (HPS.MaterialPaletteDefinition in_that)
override HPS.Type	ObjectType ()
void	Set (HPS.MaterialKit[] in_source)
void	Show (out HPS.MaterialKit[] out_source)
Public Member Functions inherited from HPS.Definition
virtual void	Assign (HPS.Definition in_that)
	Definition ()
	Definition (HPS.Definition in_that)
override bool	Equals (System.Object obj)
bool	Equals (HPS.Definition in_that)
override int	GetHashCode ()
string	Name ()
HPS.PortfolioKey	Owner ()
void	Undefine ()
Public Member Functions inherited from HPS.Object
virtual bool	Empty ()
IntPtr	GetClassID ()
IntPtr	GetInstanceID ()
bool	HasType (HPS.Type in_mask)
	Object (HPS.Object that)
virtual void	Reset ()
virtual HPS.Type	Type ()

Protected Member Functions
override void	deleteCptr ()
Protected Member Functions inherited from HPS.Object
virtual IntPtr	GetNonDirectorClassID ()

Additional Inherited Members
Static Public Member Functions inherited from HPS.Definition
static bool	operator!= (HPS.Definition a, HPS.Definition b)
static bool	operator== (HPS.Definition a, HPS.Definition b)
Static Public Member Functions inherited from HPS.Object
static IntPtr	ClassID< T > ()
Protected Attributes inherited from HPS.Object
bool	cMemOwn
HandleRef	cptr

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

MaterialPaletteDefinition() [1/3]

HPS.MaterialPaletteDefinition.MaterialPaletteDefinition ( )

inline

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

MaterialPaletteDefinition() [2/3]

HPS.MaterialPaletteDefinition.MaterialPaletteDefinition ( HPS.Definition  in_that )

inline

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() [3/3]

HPS.MaterialPaletteDefinition.MaterialPaletteDefinition ( HPS.MaterialPaletteDefinition  in_that )

inline

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.

Member Function Documentation

ObjectType()

override HPS.Type HPS.MaterialPaletteDefinition.ObjectType ( )

inlinevirtual

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.

Reimplemented from HPS.Definition.

Set()

void HPS.MaterialPaletteDefinition.Set ( HPS.MaterialKit []  in_source )

inline

Redefine the material array for this MaterialPaletteDefinition.

Parameters

in_source

The new array of materials for this MaterialPaletteDefinition.

Show()

void HPS.MaterialPaletteDefinition.Show ( out HPS.MaterialKit []  out_source )

inline

Shows the material array for this MaterialPaletteDefinition.

Parameters

out_source

The array of materials for this MaterialPaletteDefinition.

---

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

• internals/hps_core/source/cs/HPS.MaterialPaletteDefinition.cs