CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
OdSiShapePlane Struct Reference

#include <SiShapePlane.h>

Inheritance diagram for OdSiShapePlane:
OdSiShape OdSiHalfSpace OdSiShapeBoundPlane

Public Member Functions

 OdSiShapePlane (const OdGePoint3d &pointOnPlane, const OdGeVector3d &planeNormal)
 
 OdSiShapePlane (const OdGePlane &plane)
 
double signedDistanceTo (const OdGePoint3d &pt) const
 
bool contains (const OdGeExtents3d &, bool, const OdGeTol &) const
 
bool intersects (const OdGeExtents3d &extents, bool planar, const OdGeTol &tol) const
 
virtual OdSiShapeclone () const
 
virtual void transform (const OdGeMatrix3d &tf)
 
- Public Member Functions inherited from OdSiShape
virtual bool contains (const OdGeExtents3d &extents, bool planar, const OdGeTol &tol=OdGeContext::gTol) const =0
 
virtual bool intersects (const OdGeExtents3d &extents, bool planar, const OdGeTol &tol=OdGeContext::gTol) const =0
 
virtual ~OdSiShape ()
 
virtual OdSiShapeclone () const
 
virtual void transform (const OdGeMatrix3d &)
 

Public Attributes

OdGePoint3d m_pointOnPlane
 
OdGeVector3d m_planeNormal
 

Additional Inherited Members

- Static Public Member Functions inherited from OdSiShape
static bool isOverallSpace (const OdSiShape *ptr)
 
static bool isNoSpace (const OdSiShape *ptr)
 
- Static Public Attributes inherited from OdSiShape
static ODSI_API_STATIC const OdSiShapekOverallSpace
 
static ODSI_API_STATIC const OdSiShapekNoSpace
 

Detailed Description

This class represents plane implementation for OdSiShape interface.

Corresponding C++ library: SpatialIndex <group OdSi_Classes>

Definition at line 40 of file SiShapePlane.h.

Constructor & Destructor Documentation

◆ OdSiShapePlane() [1/2]

OdSiShapePlane::OdSiShapePlane ( const OdGePoint3d pointOnPlane,
const OdGeVector3d planeNormal 
)
inline

Definition at line 44 of file SiShapePlane.h.

◆ OdSiShapePlane() [2/2]

OdSiShapePlane::OdSiShapePlane ( const OdGePlane plane)
inline

Definition at line 48 of file SiShapePlane.h.

Member Function Documentation

◆ clone()

virtual OdSiShape * OdSiShapePlane::clone ( ) const
inlinevirtual

Reimplemented from OdSiShape.

Reimplemented in OdSiShapeBoundPlane, and OdSiHalfSpace.

Definition at line 125 of file SiShapePlane.h.

◆ contains()

bool OdSiShapePlane::contains ( const OdGeExtents3d extents,
bool  planar,
const OdGeTol tol 
) const
inlinevirtual

Returns true if and only if this Shape object contains the specfied extents.

Parameters
extents[in] Any 3D extents box.
planar[in] If and only if true, a planar computation is made.

Implements OdSiShape.

Reimplemented in OdSiHalfSpace.

Definition at line 55 of file SiShapePlane.h.

◆ intersects()

bool OdSiShapePlane::intersects ( const OdGeExtents3d extents,
bool  planar,
const OdGeTol tol 
) const
inlinevirtual

Returns true if and only if this Shape object intersects the specfied extents.

Parameters
extents[in] Any 3D extents box.
planar[in] If and only if true, a planar computation is made.

Implements OdSiShape.

Reimplemented in OdSiHalfSpace.

Definition at line 58 of file SiShapePlane.h.

◆ signedDistanceTo()

double OdSiShapePlane::signedDistanceTo ( const OdGePoint3d pt) const
inline

Definition at line 52 of file SiShapePlane.h.

◆ transform()

virtual void OdSiShapePlane::transform ( const OdGeMatrix3d tf)
inlinevirtual

Reimplemented from OdSiShape.

Reimplemented in OdSiShapeBoundPlane.

Definition at line 126 of file SiShapePlane.h.

Member Data Documentation

◆ m_planeNormal

OdGeVector3d OdSiShapePlane::m_planeNormal

Definition at line 42 of file SiShapePlane.h.

◆ m_pointOnPlane

OdGePoint3d OdSiShapePlane::m_pointOnPlane

Definition at line 41 of file SiShapePlane.h.


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