CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FacetModeler::Wrapper3D Class Reference

#include <FMWrapper3D.h>

Inheritance diagram for FacetModeler::Wrapper3D:
FacetModeler::Contour3D FacetModeler::Profile3D

Public Member Functions

 Wrapper3D ()
 
 Wrapper3D (const OdGeMatrix3d &rMatrix)
 
 Wrapper3D (const OdGeVector3d &vXAxis, const OdGeVector3d &vYAxis, const OdGePoint3d &ptOrigin=OdGePoint3d::kOrigin)
 
 Wrapper3D (const OdGePlane &rPlane)
 
OdGePlane plane () const
 
const OdGeMatrix3dtransform () const
 
const OdGeMatrix3dinversedTransform () const
 
Result setTransform (const OdGeMatrix3d &mTransform)
 
Result setTransform (const OdGeVector3d &vXAxis, const OdGeVector3d &vYAxis, const OdGePoint3d &ptOrigin=OdGePoint3d::kOrigin)
 
Result transformBy (const OdGeMatrix3d &mMatrix)
 
void to3D (const OdGePoint2d &rSource2D, OdGePoint3d &rDest3D) const
 
void to3D (const OdGeVector2d &rSource2D, OdGeVector3d &rDest3D) const
 
Result to2D (const OdGePoint3d &rSource3D, OdGePoint2d &rDest2D) const
 
Result to2D (const OdGeVector3d &rSource3D, OdGeVector2d &rDest2D) const
 
void swap (Wrapper3D &rAnother)
 

Detailed Description

Represents wrapper for 2D entities for using in 3D.

Definition at line 37 of file FMWrapper3D.h.

Constructor & Destructor Documentation

◆ Wrapper3D() [1/4]

FacetModeler::Wrapper3D::Wrapper3D ( )

Default constructor.

◆ Wrapper3D() [2/4]

FacetModeler::Wrapper3D::Wrapper3D ( const OdGeMatrix3d rMatrix)
explicit

Constructor. Creates a wrapper object with the specified transformation matrix.

Parameters
rMatrix[in] Transformation matrix.

◆ Wrapper3D() [3/4]

FacetModeler::Wrapper3D::Wrapper3D ( const OdGeVector3d vXAxis,
const OdGeVector3d vYAxis,
const OdGePoint3d ptOrigin = OdGePoint3d::kOrigin 
)
explicit

Constructor. Creates a wrapper object with the specified axes and point of origin.

Parameters
vXAxis[in] X axis.
vYAxis[in] Y axis.
ptOrigin[in] Point of origin.

◆ Wrapper3D() [4/4]

FacetModeler::Wrapper3D::Wrapper3D ( const OdGePlane rPlane)
explicit

Constructor. Creates a wrapper object with the specified plane.

Parameters
rPlane[in] Plane.

Member Function Documentation

◆ inversedTransform()

const OdGeMatrix3d & FacetModeler::Wrapper3D::inversedTransform ( ) const

Gets the inverse transformation matrix.

Returns
Reference to the inverse transformation matrix.

◆ plane()

OdGePlane FacetModeler::Wrapper3D::plane ( ) const

Gets the plane.

Returns
Plane as OdGePlane.

◆ setTransform() [1/2]

Result FacetModeler::Wrapper3D::setTransform ( const OdGeMatrix3d mTransform)

Sets the transformation matrix.

Parameters
mTransform[in] New transformation matrix to set.
Returns
eOk if the matrix set successfully, or a corresponding error type otherwise.

◆ setTransform() [2/2]

Result FacetModeler::Wrapper3D::setTransform ( const OdGeVector3d vXAxis,
const OdGeVector3d vYAxis,
const OdGePoint3d ptOrigin = OdGePoint3d::kOrigin 
)

Sets a transformation matrix with the specified axes and point of origin.

Parameters
vXAxis[in] X axis.
vYAxis[in] Y axis.
ptOrigin[in] Point of origin.
Returns
eOk if the matrix set successfully, or a corresponding error type otherwise.

◆ swap()

void FacetModeler::Wrapper3D::swap ( Wrapper3D rAnother)

Swaps the transformation of this object and the specified objects.

Parameters
rAnother[in] Wrapper object to swap with.

◆ to2D() [1/2]

Result FacetModeler::Wrapper3D::to2D ( const OdGePoint3d rSource3D,
OdGePoint2d rDest2D 
) const

Transforms a point from the 3D coordinate system to 2D by applying an inverse transformation matrix.

Parameters
rSource3D[in] 3D point to transform.
rDest2D[out] 2D resulting point.
Returns
eOk if the source object lies on the plane of this wrapper object, or erWarnPointNotOnThis otherwise.

◆ to2D() [2/2]

Result FacetModeler::Wrapper3D::to2D ( const OdGeVector3d rSource3D,
OdGeVector2d rDest2D 
) const

Transforms the vector from the 3D coordinate system to 2D by applying a inverse transformation matrix.

Parameters
rSource3D[in] 3D Vector to transform.
rDest2D[out] 2D Resulting vector.
Returns
eOk if the source object lies on the plane of this wrapper object, erWarnPointNotOnThis - otherwise.

◆ to3D() [1/2]

void FacetModeler::Wrapper3D::to3D ( const OdGePoint2d rSource2D,
OdGePoint3d rDest3D 
) const

Transforms a point to the 3D coordinate system by applying a transformation matrix.

Parameters
rSource2D[in] 2D point to transform.
rDest3D[out] 3D resulting point.

◆ to3D() [2/2]

void FacetModeler::Wrapper3D::to3D ( const OdGeVector2d rSource2D,
OdGeVector3d rDest3D 
) const

Transforms a vector to the 3D coordinate system by applying a transformation matrix.

Parameters
rSource2D[in] 2D vector to transform.
rDest3D[out] 3D resulting vector.

◆ transform()

const OdGeMatrix3d & FacetModeler::Wrapper3D::transform ( ) const

Gets the transformation matrix.

Returns
Reference to the transformation matrix.

◆ transformBy()

Result FacetModeler::Wrapper3D::transformBy ( const OdGeMatrix3d mMatrix)

Applies the given transformation matrix to the Wrapper3D object.

Parameters
mMatrix[in] Transformation matrix to apply.
Returns
eOk if the matrix applied successfully, or a corresponding error type otherwise.

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