Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::ModellingMatrixControl Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::ModellingMatrixControl:
Collaboration diagram for HPS::ModellingMatrixControl:

Public Member Functions

 ModellingMatrixControl (SegmentKey const &in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 ModellingMatrixControl (ReferenceKey const &in_ref)
 Initializes a control tied to the geometry reference in_ref. More...
 
 ModellingMatrixControl (ModellingMatrixControl const &in_that)
 Initializes a control tied to the same object as in_that. More...
 
 ModellingMatrixControl (ModellingMatrixControl &&in_that)
 The move constructor creates a ModellingMatrixControl by transferring the underlying impl of the rvalue reference to this ModellingMatrixControl thereby avoiding a copy and allocation. More...
 
ModellingMatrixControloperator= (ModellingMatrixControl &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this ModellingMatrixControl thereby avoiding a copy. More...
 
 ~ModellingMatrixControl ()
 Releases a reference to the database object this control is tied to. More...
 
virtual HPS::Type Type () const
 This function returns the true type of the underlying object. More...
 
HPS::Type ObjectType () const
 
ModellingMatrixControloperator= (ModellingMatrixControl const &in_that)
 Share the underlying smart-pointer of the ModellingMatrixControl source. More...
 
ModellingMatrixControlSetElement (size_t in_row, size_t in_column, float in_value)
 Sets a single matrix element. More...
 
ModellingMatrixControlSetElement (size_t in_ordinal_zero_to_fifteen, float in_value)
 Sets a single matrix element, indexed as a linear array in row-major order. More...
 
ModellingMatrixControlSetElements (FloatArray const &in_values)
 Sets some or all elements in the matrix from an array, starting with the first element. More...
 
ModellingMatrixControlSetElements (size_t in_value_count, float const in_values [])
 Sets some or all elements in the matrix from an array, starting with the first element. More...
 
ModellingMatrixControlUnsetEverything ()
 Removes all settings from this object. More...
 
bool ShowElement (size_t in_row, size_t in_column, float &out_value) const
 Shows a single matrix element. More...
 
bool ShowElement (size_t in_ordinal_zero_to_fifteen, float &out_value) const
 Shows a single matrix element, indexed as a linear array in row-major order. More...
 
bool ShowElements (FloatArray &out_matrix) const
 Shows all elements of this matrix as an array. More...
 
bool ShowDeterminant (float &out_determinant) const
 Computes the matrix determinant of this matrix. More...
 
bool ShowInverse (MatrixKit &out_matrix) const
 Computes the matrix inverse of this matrix. More...
 
bool ShowAdjoint (MatrixKit &out_matrix) const
 Computes the matrix adjoint of this matrix. More...
 
ModellingMatrixControlRotate (float in_x, float in_y, float in_z)
 Concatenates a rotation matrix to this matrix with rotation around the primary axes. More...
 
ModellingMatrixControlRotateOffAxis (Vector const &in_vector, float in_theta)
 Concatenates a rotation matrix to this matrix with rotation around an arbitrary vector. More...
 
ModellingMatrixControlTranslate (float in_x, float in_y, float in_z)
 Concatenates a translation matrix to this matrix that moves geometry. More...
 
ModellingMatrixControlTranslate (Vector const &in_translation)
 Concatenates a translation matrix to this matrix that moves geometry. More...
 
ModellingMatrixControlScale (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...
 
ModellingMatrixControlConcatenate (MatrixKit const &in_kit)
 Replaces this matrix with the matrix product of itself multiplied by another matrix. More...
 
ModellingMatrixControlNormalize ()
 Divides this matrix by its determinant. More...
 
ModellingMatrixControlInvert ()
 Replaces this matrix with it's matrix inverse. More...
 
ModellingMatrixControlAdjoint ()
 Replaces this matrix with it's matrix adjoint. More...
 
virtual bool Empty () const
 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) const
 This function indicates whether this Object has the given Type mask. More...
 
intptr_t GetClassID () const
 Returns a unique identifier that is shared by all objects of the same class. More...
 
intptr_t GetInstanceID () const
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 

Static Public Member Functions

template<typename T >
static intptr_t ClassID ()
 Unique identifier for this class. More...
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ModellingMatrixControl
 

Private Member Functions

 ModellingMatrixControl ()
 Private default constructor to prevent instantiation without a segment. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ModellingMatrixControl() [1/5]

HPS::ModellingMatrixControl::ModellingMatrixControl ( SegmentKey const &  in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ ModellingMatrixControl() [2/5]

HPS::ModellingMatrixControl::ModellingMatrixControl ( ReferenceKey const &  in_ref)
explicit

Initializes a control tied to the geometry reference in_ref.

◆ ModellingMatrixControl() [3/5]

HPS::ModellingMatrixControl::ModellingMatrixControl ( ModellingMatrixControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ ModellingMatrixControl() [4/5]

HPS::ModellingMatrixControl::ModellingMatrixControl ( ModellingMatrixControl &&  in_that)

The move constructor creates a ModellingMatrixControl by transferring the underlying impl of the rvalue reference to this ModellingMatrixControl thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a ModellingMatrixControl to take the impl from.

◆ ~ModellingMatrixControl()

HPS::ModellingMatrixControl::~ModellingMatrixControl ( )

Releases a reference to the database object this control is tied to.

◆ ModellingMatrixControl() [5/5]

HPS::ModellingMatrixControl::ModellingMatrixControl ( )
private

Private default constructor to prevent instantiation without a segment.

Member Function Documentation

◆ Adjoint()

ModellingMatrixControl& HPS::ModellingMatrixControl::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.

◆ ClassID()

template<typename T >
static intptr_t HPS::Object::ClassID ( )
inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Concatenate()

ModellingMatrixControl& HPS::ModellingMatrixControl::Concatenate ( MatrixKit const &  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.

◆ Empty()

virtual bool HPS::Object::Empty ( ) const
inlinevirtualinherited

Indicates whether this object has any values set on it.

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const
inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns
A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const
inherited

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.

Returns
A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask) const
inherited

This function indicates whether this Object has the given Type mask.

Parameters
in_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ Invert()

ModellingMatrixControl& HPS::ModellingMatrixControl::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()

ModellingMatrixControl& HPS::ModellingMatrixControl::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()

HPS::Type HPS::ModellingMatrixControl::ObjectType ( ) const
inlinevirtual

Reimplemented from HPS::Control.

Here is the call graph for this function:

◆ operator=() [1/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::operator= ( ModellingMatrixControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ModellingMatrixControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a ModellingMatrixControl to take the impl from.
Returns
A reference to this ModellingMatrixControl.

◆ operator=() [2/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::operator= ( ModellingMatrixControl const &  in_that)

Share the underlying smart-pointer of the ModellingMatrixControl source.

Parameters
in_thatThe ModellingMatrixControl source of the assignment.
Returns
A reference to this ModellingMatrixControl.

◆ Reset()

◆ Rotate()

ModellingMatrixControl& HPS::ModellingMatrixControl::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.

◆ RotateOffAxis()

ModellingMatrixControl& HPS::ModellingMatrixControl::RotateOffAxis ( Vector const &  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.

◆ Scale()

ModellingMatrixControl& HPS::ModellingMatrixControl::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.

◆ SetElement() [1/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::SetElement ( size_t  in_row,
size_t  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.

◆ SetElement() [2/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::SetElement ( size_t  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.

◆ SetElements() [1/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::SetElements ( FloatArray const &  in_values)

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

Parameters
in_valuesAn array of float values in row-major order that should replace the values in the matrix.
Returns
A reference to this object.

◆ SetElements() [2/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::SetElements ( size_t  in_value_count,
float const  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.

◆ ShowAdjoint()

bool HPS::ModellingMatrixControl::ShowAdjoint ( MatrixKit out_matrix) const

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.

◆ ShowDeterminant()

bool HPS::ModellingMatrixControl::ShowDeterminant ( float &  out_determinant) const

Computes the matrix determinant of this matrix.

Parameters
out_determinantThe matrix determinant.
Returns
true if the setting is valid, false otherwise.

◆ ShowElement() [1/2]

bool HPS::ModellingMatrixControl::ShowElement ( size_t  in_row,
size_t  in_column,
float &  out_value 
) const

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.

◆ ShowElement() [2/2]

bool HPS::ModellingMatrixControl::ShowElement ( size_t  in_ordinal_zero_to_fifteen,
float &  out_value 
) const

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.

◆ ShowElements()

bool HPS::ModellingMatrixControl::ShowElements ( FloatArray out_matrix) const

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.

◆ ShowInverse()

bool HPS::ModellingMatrixControl::ShowInverse ( MatrixKit out_matrix) const

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.

◆ Translate() [1/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::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.

◆ Translate() [2/2]

ModellingMatrixControl& HPS::ModellingMatrixControl::Translate ( Vector const &  in_translation)

Concatenates a translation matrix to this matrix that moves geometry.

Parameters
in_translationA vector distance to translate by.
Returns
A reference to this object.

◆ Type()

virtual HPS::Type HPS::ModellingMatrixControl::Type ( ) const
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()

ModellingMatrixControl& HPS::ModellingMatrixControl::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::ModellingMatrixControl::staticType = HPS::Type::ModellingMatrixControl
static

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