The TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio. More...

Public Member Functions | |
override void | Dispose () |
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 | SetOptions (HPS.TextureOptionsKit in_options) |
Redefine the texture options for this TextureDefinition. More... | |
void | SetSource (HPS.ImageDefinition in_source) |
Redefine the image for this TextureDefinition. More... | |
void | ShowOptions (out HPS.TextureOptionsKit out_options) |
Show the texture options for this TextureDefinition. More... | |
bool | ShowSource (out HPS.ImageDefinition out_source) |
Show the image for this TextureDefinition. More... | |
bool | ShowSource (out string out_source) |
Show the name of the source image for this TextureDefinition. If the source image for this TextureDefinition resides in a separate portfolio, users can use this method to retrieve the name of the source image, and use KeyPath::ShowEffectiveImageDefinition with the image name to retrieve the image definition. More... | |
TextureDefinition () | |
The default constructor creates an uninitialized TextureDefinition object. The Type() function will return Type::None. More... | |
TextureDefinition (HPS.Definition in_that) | |
This constructor creates a TextureDefinition 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 texture definition. Otherwise the copy will fail and the resulting TextureDefinition will be invalid. More... | |
TextureDefinition (HPS.TextureDefinition in_that) | |
The copy constructor creates an TextureDefinition object that shares the underlying smart-pointer of the source TextureDefinition. More... | |
![]() | |
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... | |
![]() | |
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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Definition a, HPS.Definition b) |
static bool | operator== (HPS.Definition a, HPS.Definition b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an uninitialized TextureDefinition object. The Type() function will return Type::None.
|
inline |
This constructor creates a TextureDefinition 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 texture definition. Otherwise the copy will fail and the resulting TextureDefinition will be invalid.
- Parameters
-
in_that The source Definition to copy.
|
inline |
The copy constructor creates an TextureDefinition object that shares the underlying smart-pointer of the source TextureDefinition.
- Parameters
-
in_that The source TextureDefinition to copy.
Member Function Documentation
|
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.
|
inline |
Redefine the texture options for this TextureDefinition.
- Parameters
-
in_options The new texture options for this TextureDefinition.
|
inline |
Redefine the image for this TextureDefinition.
- Parameters
-
in_source The new image for this TextureDefinition.
|
inline |
Show the texture options for this TextureDefinition.
- Parameters
-
out_options The texture options for this TextureDefinition.
|
inline |
Show the image for this TextureDefinition.
- Parameters
-
out_source The image for this TextureDefinition.
- Returns
- true if an image definition was found in the same Portfolio as this TextureDefinition, false otherwise.
|
inline |
Show the name of the source image for this TextureDefinition. If the source image for this TextureDefinition resides in a separate portfolio, users can use this method to retrieve the name of the source image, and use KeyPath::ShowEffectiveImageDefinition with the image name to retrieve the image definition.
- Parameters
-
out_source The name of the source image for this TextureDefinition.
- Returns
- true if able to retrieve the name of the source image, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TextureDefinition.cs