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

Public Member Functions | |
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 void | Dispose () |
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... | |
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... | |
HPS.PortfolioKey | Owner () |
Get the portfolio that owns this Definition. More... | |
void | Undefine () |
Removes this definition from the owning portfolio. More... | |
![]() | |
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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Definition a, HPS.Definition b) |
static bool | operator== (HPS.Definition a, HPS.Definition b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
The default constructor creates an uninitialized Definition object. The Type() function will return Type.None.
|
inline |
The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition.
- Parameters
-
in_that The source Definition to copy.
Member Function Documentation
|
inlinevirtual |
Associate this Definition with the same underlying impl as the source Definition.
- Parameters
-
in_that The source Definition for the assignment.
|
inline |
Check if the source Definition is equivalent to this Definition.
- Parameters
-
in_that The source Definition to compare to this Definition.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Get the name given to this Definition when it was defined.
- Returns
- UTF8-encoded name of this Definition.
|
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.Object.
Reimplemented in HPS.GlyphDefinition, HPS.ImageDefinition, HPS.LinePatternDefinition, HPS.MaterialPaletteDefinition, HPS.NamedStyleDefinition, HPS.ShaderDefinition, HPS.ShapeDefinition, and HPS.TextureDefinition.
|
inline |
Get the portfolio that owns this Definition.
- Returns
- The portfolio that owns this Definition.
|
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