HPS.MaterialPaletteDefinition Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 MaterialPaletteDefinition ()
 The default constructor creates an uninitialized MaterialPaletteDefinition object. The Type() function will return Type.None. More...
 
 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. More...
 
 MaterialPaletteDefinition (HPS.MaterialPaletteDefinition in_that)
 The copy constructor creates a MaterialPaletteDefinition object that shares the underlying smart-pointer of the source MaterialPaletteDefinition. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. 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...
 
- Public Member Functions inherited from HPS.Definition
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. The Type() function will return Type.None. 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...
 
- Public Member Functions inherited from HPS.Object
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. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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

HPS.MaterialPaletteDefinition.MaterialPaletteDefinition ( )
inline

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

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_thatThe source Definition to copy.
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_thatThe source MaterialPaletteDefinition to copy.

Member Function Documentation

override HPS.Type HPS.MaterialPaletteDefinition.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Definition.

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

Redefine the material array for this MaterialPaletteDefinition.

Parameters
in_sourceThe new array of materials for this MaterialPaletteDefinition.
void HPS.MaterialPaletteDefinition.Show ( out HPS.MaterialKit[]  out_source)
inline

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:
  • internals/hps_core/source/cs/HPS.MaterialPaletteDefinition.cs