REFERENCE MANUAL
The CubeMapDefinition class is a smart pointer to a database object. More...
Public Member Functions | |
CubeMapDefinition () | |
The default constructor creates an uninitialized CubeMapDefinition object. More... | |
CubeMapDefinition (HPS.Definition in_that) | |
This constructor creates a CubeMapDefinition object that shares the underlying smart-pointer of the source Definition. More... | |
CubeMapDefinition (HPS.CubeMapDefinition in_that) | |
This constructor creates a CubeMapDefinition object that shares the underlying smart-pointer of the source Definition. More... | |
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 CubeMapDefinition. 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 | ShowOptions (out HPS.TextureOptionsKit out_options) |
Show the texture options 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... | |
![]() | |
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 void | Dispose () |
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... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.PortfolioKey | Owner () |
Get the portfolio that owns this Definition. More... | |
void | Undefine () |
Removes this definition from the owning portfolio. More... | |
![]() | |
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 () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Definition a, HPS.Definition b) |
static bool | operator== (HPS.Definition a, HPS.Definition b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The CubeMapDefinition class is a smart pointer to a database object.
It is a handle to a cube map defined within a portfolio.
HPS.CubeMapDefinition.CubeMapDefinition | ( | ) |
The default constructor creates an uninitialized CubeMapDefinition object.
The Type() function will return Type::None.
HPS.CubeMapDefinition.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.
in_that | The source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy. |
HPS.CubeMapDefinition.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.
in_that | The source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.CubeMapDefinition.SetOptions | ( | HPS.TextureOptionsKit | in_options | ) |
Redefine the texture options for this CubeMapDefinition.
in_options | The 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 | ||
) |
Redefine the images for this CubeMapDefinition.
in_negative_z | The new image for the negative z-axis. |
in_positive_z | The new image for the positive z-axis. |
in_negative_x | The new image for the negative x-axis. |
in_positive_x | The new image for the positive x-axis. |
in_negative_y | The new image for the negative y-axis. |
in_positive_y | The new image for the positive y-axis. |
void HPS.CubeMapDefinition.ShowOptions | ( | out HPS.TextureOptionsKit | out_options | ) |
Show the texture options for this CubeMapDefinition.
out_options | The 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 | ||
) |
Show the images for this CubeMapDefinition.
out_negative_z | The image for the negative z-axis. |
out_positive_z | The image for the positive z-axis. |
out_negative_x | The image for the negative x-axis. |
out_positive_x | The image for the positive x-axis. |
out_negative_y | The image for the negative y-axis. |
out_positive_y | The image for the positive y-axis. |
void HPS.CubeMapDefinition.ShowSource | ( | out HPS.ImageDefinition[] | out_image_sources | ) |
Show the images for this CubeMapDefinition.
out_image_sources | The source images packed as: negative z-axis, positive z-axis, negative x-axis, positive x-axis, negative y-axis, positive y-axis. |