< Home

< Table of Contents

REFERENCE MANUAL

HPS.MatrixKit Class Reference

The MatrixKit class is a user space object, useful for carrying a group attribute settings. More...

Inheritance diagram for HPS.MatrixKit:
HPS.Object

Public Member Functions

HPS.MatrixKit Adjoint ()
 Replaces this matrix with it's matrix adjoint. More...
 
HPS.MatrixKit Concatenate (HPS.MatrixKit in_kit)
 Replaces this matrix with the matrix product of itself multiplied by another matrix. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MatrixKit in_kit)
 Check if the source MatrixKit is equivalent to this object. More...
 
override int GetHashCode ()
 
HPS.MatrixKit Invert ()
 Replaces this matrix with it's matrix inverse. More...
 
 MatrixKit ()
 Initializes an identity matrix. More...
 
 MatrixKit (HPS.MatrixKit in_kit)
 The copy constructor creates a new MatrixKit object that contains the same settings as the source object. More...
 
 MatrixKit (float[] in_matrix_source)
 This constructor allows implicit construction from an array of floats. More...
 
 MatrixKit (HPS.Quaternion in_quaternion)
 This constructor allows implicit construction from a quaternion. More...
 
HPS.MatrixKit Multiply (HPS.MatrixKit in_right)
 Performs a matrix multiplication with this object as the left operand. More...
 
HPS.MatrixKit Multiply (float in_scalar)
 Performs a scalar multiplication of this matrix. More...
 
HPS.MatrixKit MultiplyAndAssign (HPS.MatrixKit in_right)
 Performs a matrix multiplication with this object as the left operand and then assigns it to this object. More...
 
HPS.MatrixKit MultiplyAndAssign (float in_scalar)
 Performs a scalar multiplication of this matrix and then assigns it to this object. More...
 
HPS.MatrixKit Normalize ()
 Divides this matrix by its determinant. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.MatrixKit 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.MatrixKit RotateOffAxis (HPS.Vector in_vector, float in_theta)
 Concatenates a rotation matrix to this matrix with rotation around an arbitrary vector. More...
 
HPS.MatrixKit 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...
 
void Set (HPS.MatrixKit in_kit)
 Copies all settings from the source MatrixKit into this object. More...
 
HPS.MatrixKit SetElement (ulong in_row, ulong in_column, float in_value)
 Sets a single matrix element. More...
 
HPS.MatrixKit 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.MatrixKit SetElements (float[] in_values)
 Sets some or all elements in the matrix from an array, starting with the first element. More...
 
void Show (out HPS.MatrixKit out_kit)
 Copies all settings from this MatrixKit into the given MatrixKit. 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...
 
HPS.Point Transform (HPS.Point in_source)
 Transform a point through this matrix. More...
 
HPS.Point[] Transform (HPS.Point[] in_source)
 Transform an array of points through this matrix. More...
 
HPS.Vector Transform (HPS.Vector in_source)
 Transform a point through this matrix. More...
 
HPS.Vector[] Transform (HPS.Vector[] in_source)
 Transform an array of points through this matrix. More...
 
HPS.Plane Transform (HPS.Plane in_source)
 Transform a point through this matrix. More...
 
HPS.Plane[] Transform (HPS.Plane[] in_source)
 Transform an array of points through this matrix. More...
 
HPS.MatrixKit Translate (float in_x, float in_y, float in_z)
 Concatenates a translation matrix to this matrix that moves geometry. More...
 
HPS.MatrixKit UnsetEverything ()
 Sets this kit to an identity matrix. More...
 
- Public Member Functions inherited from HPS.Object
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...
 

Static Public Member Functions

static HPS.MatrixKit GetDefault ()
 Creates a MatrixKit representing the identity matrix. More...
 
static bool operator!= (HPS.MatrixKit a, HPS.MatrixKit b)
 
static bool operator== (HPS.MatrixKit a, HPS.MatrixKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The MatrixKit class is a user space object, useful for carrying a group attribute settings.

Constructor & Destructor Documentation

HPS.MatrixKit.MatrixKit ( )

Initializes an identity matrix.

HPS.MatrixKit.MatrixKit ( HPS.MatrixKit  in_kit)

The copy constructor creates a new MatrixKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.
HPS.MatrixKit.MatrixKit ( float[]  in_matrix_source)

This constructor allows implicit construction from an array of floats.

Parameters
in_matrix_sourceAn array of floats that will be used to construct a new matrix. If this array is not at least 16 elements in length, only the valid members will be used, leaving the remainder initialized as the identity matrix.
HPS.MatrixKit.MatrixKit ( HPS.Quaternion  in_quaternion)

This constructor allows implicit construction from a quaternion.

Parameters
in_quaternionA quaternion used to construct a new matrix.

Member Function Documentation

HPS.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.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.
override bool HPS.MatrixKit.Empty ( )
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS.Object.

bool HPS.MatrixKit.Equals ( HPS.MatrixKit  in_kit)

Check if the source MatrixKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_matrix_kit" kindref="compound">MatrixKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.MatrixKit HPS.MatrixKit.GetDefault ( )
static

Creates a MatrixKit representing the identity matrix.

Returns
An identity MatrixKit.
HPS.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.Multiply ( HPS.MatrixKit  in_right)

Performs a matrix multiplication with this object as the left operand.

Parameters
in_rightA matrix used as the right operand of a matrix multiplication.
Returns
A new MatrixKit representing the product.
HPS.MatrixKit HPS.MatrixKit.Multiply ( float  in_scalar)

Performs a scalar multiplication of this matrix.

Parameters
in_scalarA scalar to multiply this object by.
Returns
A new MatrixKit representing the product.
HPS.MatrixKit HPS.MatrixKit.MultiplyAndAssign ( HPS.MatrixKit  in_right)

Performs a matrix multiplication with this object as the left operand and then assigns it to this object.

Parameters
in_rightA matrix used as the right operand of a matrix multiplication.
Returns
A reference to this object after the multiplication.
HPS.MatrixKit HPS.MatrixKit.MultiplyAndAssign ( float  in_scalar)

Performs a scalar multiplication of this matrix and then assigns it to this object.

Parameters
in_scalarA scalar to multiply this object by.
Returns
A reference to this object after the multiplication.
HPS.MatrixKit HPS.MatrixKit.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.MatrixKit.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.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.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.
void HPS.MatrixKit.Set ( HPS.MatrixKit  in_kit)

Copies all settings from the source MatrixKit into this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_matrix_kit" kindref="compound">MatrixKit</ref> to copy.
HPS.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.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.
void HPS.MatrixKit.Show ( out HPS.MatrixKit  out_kit)

Copies all settings from this MatrixKit into the given MatrixKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_matrix_kit" kindref="compound">MatrixKit</ref> to populate with the contents of this object.
bool HPS.MatrixKit.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.MatrixKit.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.MatrixKit.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.MatrixKit.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.MatrixKit.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.MatrixKit.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.Point HPS.MatrixKit.Transform ( HPS.Point  in_source)

Transform a point through this matrix.

Parameters
in_sourceThe point to apply a transformation to.
Returns
A new point representing the transformed point.
HPS.Point [] HPS.MatrixKit.Transform ( HPS.Point[]  in_source)

Transform an array of points through this matrix.

Parameters
in_countThe number of elements in the source array.
in_sourceAn array of points to apply a transformation to.
Returns
A new point array representing the transformed points.
HPS.Vector HPS.MatrixKit.Transform ( HPS.Vector  in_source)

Transform a point through this matrix.

Parameters
in_sourceThe point to apply a transformation to.
Returns
A new point representing the transformed point.
HPS.Vector [] HPS.MatrixKit.Transform ( HPS.Vector[]  in_source)

Transform an array of points through this matrix.

Parameters
in_countThe number of elements in the source array.
in_sourceAn array of points to apply a transformation to.
Returns
A new point array representing the transformed points.
HPS.Plane HPS.MatrixKit.Transform ( HPS.Plane  in_source)

Transform a point through this matrix.

Parameters
in_sourceThe point to apply a transformation to.
Returns
A new point representing the transformed point.
HPS.Plane [] HPS.MatrixKit.Transform ( HPS.Plane[]  in_source)

Transform an array of points through this matrix.

Parameters
in_countThe number of elements in the source array.
in_sourceAn array of points to apply a transformation to.
Returns
A new point array representing the transformed points.
HPS.MatrixKit HPS.MatrixKit.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.MatrixKit HPS.MatrixKit.UnsetEverything ( )

Sets this kit to an identity matrix.

Returns
A reference to this kit.

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