< Home

< Table of Contents

REFERENCE MANUAL

HPS.TextureMatrixControl Class Reference

The TextureMatrixControl class is a smart pointer that is tied to a database object. More...

Inheritance diagram for HPS.TextureMatrixControl:
HPS.Control HPS.Object

Public Member Functions

HPS.TextureMatrixControl Adjoint ()
 Replaces this matrix with it's matrix adjoint. More...
 
HPS.TextureMatrixControl Concatenate (HPS.MatrixKit in_kit)
 Replaces this matrix with the matrix product of itself multiplied by another matrix. More...
 
override void Dispose ()
 
HPS.TextureMatrixControl Invert ()
 Replaces this matrix with it's matrix inverse. More...
 
HPS.TextureMatrixControl Normalize ()
 Divides this matrix by its determinant. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.TextureMatrixControl Rotate (float in_x, float in_y, float in_z)
 Concatenates a rotation matrix to this matrix with rotation around the primary axes. More...
 
HPS.TextureMatrixControl RotateOffAxis (HPS.Vector in_vector, float in_theta)
 Concatenates a rotation matrix to this matrix with rotation around an arbitrary vector. More...
 
HPS.TextureMatrixControl Scale (float in_x, float in_y, float in_z)
 Concatenates a scale matrix to this matrix that represents a uniform scaling of the scene. More...
 
HPS.TextureMatrixControl SetElement (ulong in_row, ulong in_column, float in_value)
 Sets a single matrix element. More...
 
HPS.TextureMatrixControl SetElement (ulong in_ordinal_zero_to_fifteen, float in_value)
 Sets a single matrix element, indexed as a linear array in row-major order. More...
 
HPS.TextureMatrixControl SetElements (float[] in_values)
 Sets some or all elements in the matrix from an array, starting with the first element. More...
 
bool ShowAdjoint (out HPS.MatrixKit out_matrix)
 Computes the matrix adjoint of this matrix. More...
 
bool ShowDeterminant (out float out_determinant)
 Computes the matrix determinant of this matrix. More...
 
bool ShowElement (ulong in_row, ulong in_column, out float out_value)
 Shows a single matrix element. More...
 
bool ShowElement (ulong in_ordinal_zero_to_fifteen, out float out_value)
 Shows a single matrix element, indexed as a linear array in row-major order. More...
 
bool ShowElements (out float[] out_matrix)
 Shows all elements of this matrix as an array. More...
 
bool ShowInverse (out HPS.MatrixKit out_matrix)
 Computes the matrix inverse of this matrix. More...
 
 TextureMatrixControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 TextureMatrixControl (HPS.TextureMatrixControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
HPS.TextureMatrixControl Translate (float in_x, float in_y, float in_z)
 Concatenates a translation matrix to this matrix that moves geometry. More...
 
HPS.TextureMatrixControl UnsetEverything ()
 Removes all settings from this object. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- 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.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The TextureMatrixControl class is a smart pointer that is tied to a database object.

It controls the various attributes related to texture matrices.

Constructor & Destructor Documentation

HPS.TextureMatrixControl.TextureMatrixControl ( HPS.SegmentKey  in_seg)

Initializes a control tied to the segment in_seg.

HPS.TextureMatrixControl.TextureMatrixControl ( HPS.TextureMatrixControl  in_that)

Initializes a control tied to the same object as in_that.

Member Function Documentation

HPS.TextureMatrixControl HPS.TextureMatrixControl.Adjoint ( )

Replaces this matrix with it's matrix adjoint.

The adjoint is similar to the inverse but is always guaranteed to exist, even for singular matrices.

Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.Concatenate ( HPS.MatrixKit  in_kit)

Replaces this matrix with the matrix product of itself multiplied by another matrix.

Parameters
in_kitthe right side operand of the matrix multiplication.
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.Invert ( )

Replaces this matrix with it's matrix inverse.

If this matrix is singular (determinant = 0), it will be unchanged.

Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.Normalize ( )

Divides this matrix by its determinant.

If this matrix is singular (determinant = 0), it will be unchanged.

Returns
A reference to this object.
override HPS.Type HPS.TextureMatrixControl.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.Object.

HPS.TextureMatrixControl HPS.TextureMatrixControl.Rotate ( float  in_x,
float  in_y,
float  in_z 
)

Concatenates a rotation matrix to this matrix with rotation around the primary axes.

Parameters
in_xThe number of degrees to rotate around the x-axis.
in_yThe number of degrees to rotate around the y-axis.
in_zThe number of degrees to rotate around the z-axis.
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.RotateOffAxis ( HPS.Vector  in_vector,
float  in_theta 
)

Concatenates a rotation matrix to this matrix with rotation around an arbitrary vector.

Parameters
in_vectorThe vector to rotate around.
in_thetathe number of degrees to rotate around the specified vector
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.Scale ( float  in_x,
float  in_y,
float  in_z 
)

Concatenates a scale matrix to this matrix that represents a uniform scaling of the scene.

Parameters
in_xThe scale multiplier along the x-axis.
in_yThe scale multiplier along the y-axis.
in_zThe scale multiplier along the z-axis.
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.SetElement ( ulong  in_row,
ulong  in_column,
float  in_value 
)

Sets a single matrix element.

Parameters
in_rowThe row index. Valid range is [0, 3].
in_columnThe column index. Valid range is [0, 3].
in_valueThe matrix element.
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.SetElement ( ulong  in_ordinal_zero_to_fifteen,
float  in_value 
)

Sets a single matrix element, indexed as a linear array in row-major order.

Parameters
in_ordinal_zero_to_fifteenThe offset into the matrix. Valid range is [0, 15].
in_valueThe matrix element.
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.SetElements ( float[]  in_values)

Sets some or all elements in the matrix from an array, starting with the first element.

Parameters
in_value_countthe number of elements in the input array. Valid range is [0, 16].
in_valuesAn array of float values in row-major order that should replace the values in the matrix.
Returns
A reference to this object.
bool HPS.TextureMatrixControl.ShowAdjoint ( out HPS.MatrixKit  out_matrix)

Computes the matrix adjoint of this matrix.

The adjoint is similar to the inverse but is always guaranteed to exist, even for singular matrices.

Parameters
out_matrixThe matrix adjoint of this matrix.
Returns
true if the setting is valid, false otherwise.
bool HPS.TextureMatrixControl.ShowDeterminant ( out float  out_determinant)

Computes the matrix determinant of this matrix.

Parameters
out_determinantThe matrix determinant.
Returns
true if the setting is valid, false otherwise.
bool HPS.TextureMatrixControl.ShowElement ( ulong  in_row,
ulong  in_column,
out float  out_value 
)

Shows a single matrix element.

Parameters
in_rowThe row index. Valid range is [0, 3].
in_columnThe column index. Valid range is [0, 3].
out_valueThe matrix element.
Returns
true if the setting is valid, false otherwise.
bool HPS.TextureMatrixControl.ShowElement ( ulong  in_ordinal_zero_to_fifteen,
out float  out_value 
)

Shows a single matrix element, indexed as a linear array in row-major order.

Parameters
in_ordinal_zero_to_fifteenThe offset into the matrix. Valid range is [0, 15].
out_valueThe matrix element.
Returns
true if the setting is valid, false otherwise.
bool HPS.TextureMatrixControl.ShowElements ( out float[]  out_matrix)

Shows all elements of this matrix as an array.

Parameters
out_matrixThe contents of the matrix arranged as a linear array in row-major order.
Returns
true if the setting is valid, false otherwise.
bool HPS.TextureMatrixControl.ShowInverse ( out HPS.MatrixKit  out_matrix)

Computes the matrix inverse of this matrix.

Fails if this matrix is singular (determinant = 0).

Parameters
out_matrixThe matrix inverse of this matrix.
Returns
true if the setting is valid, false otherwise.
HPS.TextureMatrixControl HPS.TextureMatrixControl.Translate ( float  in_x,
float  in_y,
float  in_z 
)

Concatenates a translation matrix to this matrix that moves geometry.

Parameters
in_xThe number of units to translate along the x-axis.
in_yThe number of units to translate along the y-axis.
in_zThe number of units to translate along the z-axis.
Returns
A reference to this object.
HPS.TextureMatrixControl HPS.TextureMatrixControl.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

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