|
HPS.ModellingMatrixControl | Adjoint () |
|
HPS.ModellingMatrixControl | Concatenate (HPS.MatrixKit in_kit) |
|
override void | Dispose () |
|
HPS.ModellingMatrixControl | Invert () |
|
| ModellingMatrixControl (HPS.SegmentKey in_seg) |
|
| ModellingMatrixControl (HPS.ReferenceKey in_ref) |
|
| ModellingMatrixControl (HPS.ModellingMatrixControl in_that) |
|
HPS.ModellingMatrixControl | Normalize () |
|
override HPS.Type | ObjectType () |
|
HPS.ModellingMatrixControl | Rotate (float in_x, float in_y, float in_z) |
|
HPS.ModellingMatrixControl | RotateOffAxis (HPS.Vector in_vector, float in_theta) |
|
HPS.ModellingMatrixControl | Scale (float in_x, float in_y, float in_z) |
|
HPS.ModellingMatrixControl | Set (HPS.MatrixKit in_matrix) |
|
HPS.ModellingMatrixControl | SetElement (ulong in_row, ulong in_column, float in_value) |
|
HPS.ModellingMatrixControl | SetElement (ulong in_ordinal_zero_to_fifteen, float in_value) |
|
HPS.ModellingMatrixControl | SetElements (float[] in_values) |
|
bool | Show (out HPS.MatrixKit out_matrix) |
|
bool | ShowAdjoint (out HPS.MatrixKit out_matrix) |
|
bool | ShowDeterminant (out float out_determinant) |
|
bool | ShowElement (ulong in_row, ulong in_column, out float out_value) |
|
bool | ShowElement (ulong in_ordinal_zero_to_fifteen, out float out_value) |
|
bool | ShowElements (out float[] out_matrix) |
|
bool | ShowInverse (out HPS.MatrixKit out_matrix) |
|
HPS.ModellingMatrixControl | Translate (float in_x, float in_y, float in_z) |
|
HPS.ModellingMatrixControl | Translate (HPS.Vector in_translation) |
|
override HPS.Type | Type () |
|
HPS.ModellingMatrixControl | UnsetEverything () |
|
| Control (HPS.Control in_that) |
|
virtual bool | Empty () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ModellingMatrixControl class is a smart pointer that is tied to a database object. This control gives you access to a segment's modelling matrix. You can set an entire matrix or individual elements. Additionally, this class provides a small set of utility methods for all the basic transformations, as well as getting the matrix adjoint and determinant. Elements of modelling matrices are in row-major order.
◆ ModellingMatrixControl() [1/3]
HPS.ModellingMatrixControl.ModellingMatrixControl |
( |
HPS.SegmentKey |
in_seg | ) |
|
|
inline |
Initializes a control tied to the segment in_seg.
◆ ModellingMatrixControl() [2/3]
Initializes a control tied to the geometry reference in_ref.
◆ ModellingMatrixControl() [3/3]
Initializes a control tied to the same object as in_that.
◆ 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.
◆ Concatenate()
Replaces this matrix with the matrix product of itself multiplied by another matrix.
- Parameters
-
in_kit | the right side operand of the matrix multiplication. |
- Returns
- A reference to this object.
◆ 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.
◆ Normalize()
Divides this matrix by its determinant. If this matrix is singular (determinant = 0), it will be unchanged.
- Returns
- A reference to this object.
◆ ObjectType()
override HPS.Type HPS.ModellingMatrixControl.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.Control.
◆ Rotate()
Concatenates a rotation matrix to this matrix with rotation around the primary axes.
- Parameters
-
in_x | The number of degrees to rotate around the x-axis. |
in_y | The number of degrees to rotate around the y-axis. |
in_z | The number of degrees to rotate around the z-axis. |
- Returns
- A reference to this object.
◆ RotateOffAxis()
Concatenates a rotation matrix to this matrix with rotation around an arbitrary vector.
- Parameters
-
in_vector | The vector to rotate around. |
in_theta | the number of degrees to rotate around the specified vector |
- Returns
- A reference to this object.
◆ Scale()
Concatenates a scale matrix to this matrix that represents a uniform scaling of the scene.
- Parameters
-
in_x | The scale multiplier along the x-axis. |
in_y | The scale multiplier along the y-axis. |
in_z | The scale multiplier along the z-axis. |
- Returns
- A reference to this object.
◆ Set()
Copies all settings from the source MatrixKit into this object.
- Parameters
-
◆ SetElement() [1/2]
Sets a single matrix element.
- Parameters
-
in_row | The row index. Valid range is [0, 3]. |
in_column | The column index. Valid range is [0, 3]. |
in_value | The matrix element. |
- Returns
- A reference to this object.
◆ SetElement() [2/2]
Sets a single matrix element, indexed as a linear array in row-major order.
- Parameters
-
in_ordinal_zero_to_fifteen | The offset into the matrix. Valid range is [0, 15]. |
in_value | The matrix element. |
- Returns
- A reference to this object.
◆ SetElements()
Sets some or all elements in the matrix from an array, starting with the first element.
- Parameters
-
in_values | An array of float values in row-major order that should replace the values in the matrix. |
- Returns
- A reference to this object.
◆ Show()
bool HPS.ModellingMatrixControl.Show |
( |
out HPS.MatrixKit |
out_matrix | ) |
|
|
inline |
Copies all settings from this control into the given MatrixKit.
- Parameters
-
out_matrix | The MatrixKit to populate with the contents of this object. |
◆ ShowAdjoint()
bool HPS.ModellingMatrixControl.ShowAdjoint |
( |
out HPS.MatrixKit |
out_matrix | ) |
|
|
inline |
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_matrix | The matrix adjoint of this matrix. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowDeterminant()
bool HPS.ModellingMatrixControl.ShowDeterminant |
( |
out float |
out_determinant | ) |
|
|
inline |
Computes the matrix determinant of this matrix.
- Parameters
-
out_determinant | The matrix determinant. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowElement() [1/2]
bool HPS.ModellingMatrixControl.ShowElement |
( |
ulong |
in_row, |
|
|
ulong |
in_column, |
|
|
out float |
out_value |
|
) |
| |
|
inline |
Shows a single matrix element.
- Parameters
-
in_row | The row index. Valid range is [0, 3]. |
in_column | The column index. Valid range is [0, 3]. |
out_value | The matrix element. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowElement() [2/2]
bool HPS.ModellingMatrixControl.ShowElement |
( |
ulong |
in_ordinal_zero_to_fifteen, |
|
|
out float |
out_value |
|
) |
| |
|
inline |
Shows a single matrix element, indexed as a linear array in row-major order.
- Parameters
-
in_ordinal_zero_to_fifteen | The offset into the matrix. Valid range is [0, 15]. |
out_value | The matrix element. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowElements()
bool HPS.ModellingMatrixControl.ShowElements |
( |
out float [] |
out_matrix | ) |
|
|
inline |
Shows all elements of this matrix as an array.
- Parameters
-
out_matrix | The contents of the matrix arranged as a linear array in row-major order. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowInverse()
bool HPS.ModellingMatrixControl.ShowInverse |
( |
out HPS.MatrixKit |
out_matrix | ) |
|
|
inline |
Computes the matrix inverse of this matrix. Fails if this matrix is singular (determinant = 0).
- Parameters
-
out_matrix | The matrix inverse of this matrix. |
- Returns
- true if the setting is valid, false otherwise.
◆ Translate() [1/2]
Concatenates a translation matrix to this matrix that moves geometry.
- Parameters
-
in_x | The number of units to translate along the x-axis. |
in_y | The number of units to translate along the y-axis. |
in_z | The number of units to translate along the z-axis. |
- Returns
- A reference to this object.
◆ Translate() [2/2]
Concatenates a translation matrix to this matrix that moves geometry.
- Parameters
-
in_translation | A vector distance to translate by. |
- Returns
- A reference to this object.
◆ Type()
override HPS.Type HPS.ModellingMatrixControl.Type |
( |
| ) |
|
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ModellingMatrixControl.cs