API Search || Global Search
HPS.TextureDefinition Class Reference

More...

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

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...
 
- 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...
 
virtual 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 TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio.

Constructor & Destructor Documentation

HPS.TextureDefinition.TextureDefinition ( )
inline

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

HPS.TextureDefinition.TextureDefinition ( HPS.Definition  in_that)
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_thatThe source Definition to copy.
HPS.TextureDefinition.TextureDefinition ( HPS.TextureDefinition  in_that)
inline

The copy constructor creates an TextureDefinition object that shares the underlying smart-pointer of the source TextureDefinition.

Parameters
in_thatThe source TextureDefinition to copy.

Member Function Documentation

override HPS.Type HPS.TextureDefinition.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.TextureDefinition.SetOptions ( HPS.TextureOptionsKit  in_options)
inline

Redefine the texture options for this TextureDefinition.

Parameters
in_optionsThe new texture options for this TextureDefinition.
void HPS.TextureDefinition.SetSource ( HPS.ImageDefinition  in_source)
inline

Redefine the image for this TextureDefinition.

Parameters
in_sourceThe new image for this TextureDefinition.
void HPS.TextureDefinition.ShowOptions ( out HPS.TextureOptionsKit  out_options)
inline

Show the texture options for this TextureDefinition.

Parameters
out_optionsThe texture options for this TextureDefinition.
bool HPS.TextureDefinition.ShowSource ( out HPS.ImageDefinition  out_source)
inline

Show the image for this TextureDefinition.

Parameters
out_sourceThe image for this TextureDefinition.
Returns
    true if an image definition was found in the same Portfolio as this TextureDefinition, false otherwise.
bool HPS.TextureDefinition.ShowSource ( out string  out_source)
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_sourceThe 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