< Home

< Table of Contents

REFERENCE MANUAL

HPS.TextureDefinition Class Reference

The TextureDefinition class is a smart pointer to a database object. 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. 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...
 
void ShowSource (out HPS.ImageDefinition out_source)
 Show the image for this TextureDefinition. More...
 
 TextureDefinition ()
 The default constructor creates an uninitialized TextureDefinition object. More...
 
 TextureDefinition (HPS.Definition in_that)
 This constructor creates a TextureDefinition object that shares the underlying smart-pointer of the source Definition. More...
 
 TextureDefinition (HPS.TextureDefinition in_that)
 This constructor creates a TextureDefinition object that shares the underlying smart-pointer of the source Definition. 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. 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. 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
 
HandleRef scptr
 

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 ( )

The default constructor creates an uninitialized TextureDefinition object.

The Type() function will return Type::None.

HPS.TextureDefinition.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.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy.
HPS.TextureDefinition.TextureDefinition ( HPS.TextureDefinition  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.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy.

Member Function Documentation

override HPS.Type HPS.TextureDefinition.ObjectType ( )
virtual

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)

Redefine the texture options for this TextureDefinition.

Parameters
in_optionsThe new texture options for this <ref refid="class_h_p_s_1_1_texture_definition" kindref="compound">TextureDefinition</ref>.
void HPS.TextureDefinition.SetSource ( HPS.ImageDefinition  in_source)

Redefine the image for this TextureDefinition.

Parameters
in_sourceThe new image for this <ref refid="class_h_p_s_1_1_texture_definition" kindref="compound">TextureDefinition</ref>.
void HPS.TextureDefinition.ShowOptions ( out HPS.TextureOptionsKit  out_options)

Show the texture options for this TextureDefinition.

Parameters
out_optionsThe texture options for this <ref refid="class_h_p_s_1_1_texture_definition" kindref="compound">TextureDefinition</ref>.
void HPS.TextureDefinition.ShowSource ( out HPS.ImageDefinition  out_source)

Show the image for this TextureDefinition.

Parameters
out_sourceThe image for this <ref refid="class_h_p_s_1_1_texture_definition" kindref="compound">TextureDefinition</ref>.

The documentation for this class was generated from the following file: