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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
void SetOptions (HPS.TextureOptionsKit in_options)
 
void SetSource (HPS.ImageDefinition in_source)
 
void ShowOptions (out HPS.TextureOptionsKit out_options)
 
bool ShowSource (out HPS.ImageDefinition out_source)
 
bool ShowSource (out string out_source)
 
 TextureDefinition ()
 
 TextureDefinition (HPS.Definition in_that)
 
 TextureDefinition (HPS.TextureDefinition in_that)
 
- Public Member Functions inherited from HPS.Definition
virtual void Assign (HPS.Definition in_that)
 
 Definition ()
 
 Definition (HPS.Definition in_that)
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Definition in_that)
 
override int GetHashCode ()
 
string Name ()
 
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 ()
 

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

◆ TextureDefinition() [1/3]

HPS.TextureDefinition.TextureDefinition ( )
inline

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

◆ TextureDefinition() [2/3]

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.

◆ TextureDefinition() [3/3]

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

◆ ObjectType()

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

◆ SetOptions()

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.

◆ SetSource()

void HPS.TextureDefinition.SetSource ( HPS.ImageDefinition  in_source)
inline

Redefine the image for this TextureDefinition.

Parameters
in_sourceThe new image for this TextureDefinition.

◆ ShowOptions()

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.

◆ ShowSource() [1/2]

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.

◆ ShowSource() [2/2]

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