Public Member Functions | Protected Member Functions | List of all members
HPS.CubeMapDefinition Class Reference

The CubeMapDefinition class is a smart pointer to a database object. It is a handle to a cube map defined within a portfolio. More...

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

Public Member Functions

override void Dispose ()
 
 CubeMapDefinition ()
 The default constructor creates an uninitialized CubeMapDefinition object. The Type() function will return Type::None. More...
 
 CubeMapDefinition (HPS.Definition in_that)
 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. More...
 
 CubeMapDefinition (HPS.CubeMapDefinition in_that)
 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. More...
 
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 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)
 Redefine the images for this CubeMapDefinition. More...
 
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)
 Show the images for this CubeMapDefinition. More...
 
void ShowSource (out HPS.ImageDefinition[] out_image_sources)
 Show the images for this CubeMapDefinition. More...
 
void SetOptions (HPS.TextureOptionsKit in_options)
 Redefine the texture options for this CubeMapDefinition. More...
 
void ShowOptions (out HPS.TextureOptionsKit out_options)
 Show the texture options for this CubeMapDefinition. More...
 
- Public Member Functions inherited from HPS.Definition
override void Dispose ()
 
 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 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 Undefine ()
 Removes this definition from the owning portfolio. More...
 
HPS.PortfolioKey Owner ()
 Get the portfolio that owns this Definition. More...
 
string Name ()
 Get the name given to this Definition when it was defined. More...
 
virtual void Assign (HPS.Definition in_that)
 Associate this Definition with the same underlying impl as the source Definition. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Definition in_that)
 Check if the source Definition is equivalent to this Definition. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.CubeMapDefinition.CubeMapDefinition ( )
inline

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

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

Member Function Documentation

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

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

Redefine the texture options for this CubeMapDefinition.

Parameters
in_optionsThe new texture options for this <ref refid="class_h_p_s_1_1_cube_map_definition" kindref="compound">CubeMapDefinition</ref>.
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.
void HPS.CubeMapDefinition.ShowOptions ( out HPS.TextureOptionsKit  out_options)
inline

Show the texture options for this CubeMapDefinition.

Parameters
out_optionsThe texture options for this <ref refid="class_h_p_s_1_1_cube_map_definition" kindref="compound">CubeMapDefinition</ref>.
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.
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: