Inheritance diagram for HPS.Definition:
HPS.Object HPS.CubeMapDefinition HPS.GlyphDefinition HPS.ImageDefinition HPS.LinePatternDefinition HPS.MaterialPaletteDefinition HPS.NamedStyleDefinition HPS.ShapeDefinition HPS.TextureDefinition

Public Member Functions

virtual void Assign (HPS.Definition in_that)
 
 Definition ()
 
 Definition (HPS.Definition in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Definition in_that)
 
override int GetHashCode ()
 
string Name ()
 
override HPS.Type ObjectType ()
 
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 ()
 

Static Public Member Functions

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 Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The Definition class is a smart pointer to a database object. It is the base class for all definition objects.

Constructor & Destructor Documentation

◆ Definition() [1/2]

HPS.Definition.Definition ( )
inline

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

◆ Definition() [2/2]

HPS.Definition.Definition ( HPS.Definition  in_that)
inline

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

Parameters
in_thatThe source Definition to copy.

Member Function Documentation

◆ Assign()

virtual void HPS.Definition.Assign ( HPS.Definition  in_that)
inlinevirtual

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

Parameters
in_thatThe source Definition for the assignment.

◆ Equals()

bool HPS.Definition.Equals ( HPS.Definition  in_that)
inline

Check if the source Definition is equivalent to this Definition.

Parameters
in_thatThe source Definition to compare to this Definition.
Returns
true if the objects are equivalent, false otherwise.

◆ Name()

string HPS.Definition.Name ( )
inline

Get the name given to this Definition when it was defined.

Returns
UTF8-encoded name of this Definition.

◆ ObjectType()

override HPS.Type HPS.Definition.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.Object.

Reimplemented in HPS.GlyphDefinition, HPS.ImageDefinition, HPS.LinePatternDefinition, HPS.MaterialPaletteDefinition, HPS.NamedStyleDefinition, HPS.ShapeDefinition, and HPS.TextureDefinition.

◆ Owner()

HPS.PortfolioKey HPS.Definition.Owner ( )
inline

Get the portfolio that owns this Definition.

Returns
The portfolio that owns this Definition.

◆ Undefine()

void HPS.Definition.Undefine ( )
inline

Removes this definition from the owning portfolio.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.Definition.cs