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

Public Member Functions

 CubeMapDefinition ()
 
 CubeMapDefinition (HPS.Definition in_that)
 
 CubeMapDefinition (HPS.CubeMapDefinition in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
void SetOptions (HPS.TextureOptionsKit in_options)
 
void SetSource (HPS.ImageDefinition in_negative_z, HPS.ImageDefinition in_positive_z, HPS.ImageDefinition in_negative_x, HPS.ImageDefinition in_positive_x, HPS.ImageDefinition in_negative_y, HPS.ImageDefinition in_positive_y)
 
void ShowOptions (out HPS.TextureOptionsKit out_options)
 
void ShowSource (out HPS.ImageDefinition out_negative_z, out HPS.ImageDefinition out_positive_z, out HPS.ImageDefinition out_negative_x, out HPS.ImageDefinition out_positive_x, out HPS.ImageDefinition out_negative_y, out HPS.ImageDefinition out_positive_y)
 
void ShowSource (out HPS.ImageDefinition[] out_image_sources)
 
- Public Member Functions inherited from HPS.Definition
virtual void Assign (HPS.Definition in_that)
 
 Definition ()
 
 Definition (HPS.Definition in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Definition in_that)
 
override int GetHashCode ()
 
string Name ()
 
override HPS.Type ObjectType ()
 
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.Definition
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 CubeMapDefinition class is a smart pointer to a database object. It is a handle to a cube map defined within a portfolio.

Constructor & Destructor Documentation

◆ CubeMapDefinition() [1/3]

HPS.CubeMapDefinition.CubeMapDefinition ( )
inline

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

◆ CubeMapDefinition() [2/3]

HPS.CubeMapDefinition.CubeMapDefinition ( HPS.Definition  in_that)
inline

This constructor creates a CubeMapDefinition 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 cube map definition. Otherwise the copy will fail and the resulting CubeMapDefinition will be invalid.

Parameters
in_thatThe source Definition to copy.

◆ CubeMapDefinition() [3/3]

HPS.CubeMapDefinition.CubeMapDefinition ( HPS.CubeMapDefinition  in_that)
inline

The copy constructor creates a CubeMapDefinition object that shares the underlying smart-pointer of the source CubeMapDefinition.

Parameters
in_thatThe source CubeMapDefinition to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.CubeMapDefinition.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.Object.

◆ SetOptions()

void HPS.CubeMapDefinition.SetOptions ( HPS.TextureOptionsKit  in_options)
inline

Redefine the texture options for this CubeMapDefinition.

Parameters
in_optionsThe new texture options for this CubeMapDefinition.

◆ SetSource()

void HPS.CubeMapDefinition.SetSource ( HPS.ImageDefinition  in_negative_z,
HPS.ImageDefinition  in_positive_z,
HPS.ImageDefinition  in_negative_x,
HPS.ImageDefinition  in_positive_x,
HPS.ImageDefinition  in_negative_y,
HPS.ImageDefinition  in_positive_y 
)
inline

Redefine the images for this CubeMapDefinition.

Parameters
in_negative_zThe new image for the negative z-axis.
in_positive_zThe new image for the positive z-axis.
in_negative_xThe new image for the negative x-axis.
in_positive_xThe new image for the positive x-axis.
in_negative_yThe new image for the negative y-axis.
in_positive_yThe new image for the positive y-axis.

◆ ShowOptions()

void HPS.CubeMapDefinition.ShowOptions ( out HPS.TextureOptionsKit  out_options)
inline

Show the texture options for this CubeMapDefinition.

Parameters
out_optionsThe texture options for this CubeMapDefinition.

◆ ShowSource() [1/2]

void HPS.CubeMapDefinition.ShowSource ( out HPS.ImageDefinition  out_negative_z,
out HPS.ImageDefinition  out_positive_z,
out HPS.ImageDefinition  out_negative_x,
out HPS.ImageDefinition  out_positive_x,
out HPS.ImageDefinition  out_negative_y,
out HPS.ImageDefinition  out_positive_y 
)
inline

Show the images for this CubeMapDefinition.

Parameters
out_negative_zThe image for the negative z-axis.
out_positive_zThe image for the positive z-axis.
out_negative_xThe image for the negative x-axis.
out_positive_xThe image for the positive x-axis.
out_negative_yThe image for the negative y-axis.
out_positive_yThe image for the positive y-axis.

◆ ShowSource() [2/2]

void HPS.CubeMapDefinition.ShowSource ( out HPS.ImageDefinition []  out_image_sources)
inline

Show the images for this CubeMapDefinition.

Parameters
out_image_sourcesThe source images packed as: negative z-axis, positive z-axis, negative x-axis, positive x-axis, negative y-axis, positive y-axis.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.CubeMapDefinition.cs