OdSiShapeBoundPlane Struct Reference

#include <SiShapeBoundPlane.h>

Inheritance diagram for OdSiShapeBoundPlane:

Public Member Functions
	OdSiShapeBoundPlane (const OdGePoint3d &origin, const OdGeVector3d &planeNormal, const OdGeExtents3d &bounds)
	OdSiShapeBoundPlane (const OdGePlane &plane, const OdGeExtents3d &bounds)
bool	contains (const OdGeExtents3d &extents, bool planar, const OdGeTol &tol) const
bool	intersects (const OdGeExtents3d &extents, bool planar, const OdGeTol &tol) const
virtual OdSiShape *	clone () const
virtual void	transform (const OdGeMatrix3d &tf)
Public Member Functions inherited from OdSiShapePlane
	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 OdSiShape *	clone () 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 OdSiShape *	clone () const
virtual void	transform (const OdGeMatrix3d &)

Public Attributes
OdGeExtents3d	m_bounds
Public Attributes inherited from OdSiShapePlane
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 OdSiShape &	kOverallSpace
static ODSI_API_STATIC const OdSiShape &	kNoSpace

Detailed Description

Represents bounded plane implementation for OdSiShape interface.

Corresponding C++ library: SpatialIndex <group OdSi_Classes>

Definition at line 41 of file SiShapeBoundPlane.h.

Constructor & Destructor Documentation

OdSiShapeBoundPlane() [1/2]

OdSiShapeBoundPlane::OdSiShapeBoundPlane ( const OdGePoint3d &  origin, const OdGeVector3d &  planeNormal, const OdGeExtents3d &  bounds  )

inline

Creates a new instance of a shape bounded plane.

Parameters

origin	[in] Origin of plane.
planeNormal	[in] The normal to the plane.
bounds	[in] Box bounding the plane.

Definition at line 53 of file SiShapeBoundPlane.h.

OdSiShapeBoundPlane() [2/2]

OdSiShapeBoundPlane::OdSiShapeBoundPlane ( const OdGePlane &  plane, const OdGeExtents3d &  bounds  )

inline

Creates a new instance of a shape bounded plane.

Parameters

plane	[in] Plane.
bounds	[in] Box bounding the plane.

Definition at line 65 of file SiShapeBoundPlane.h.

Member Function Documentation

clone()

virtual OdSiShape * OdSiShapeBoundPlane::clone ( ) const

inlinevirtual

Clones this shape bounded plane object.

Returns

a pointer to the newly created shape object.

Reimplemented from OdSiShapePlane.

Definition at line 110 of file SiShapeBoundPlane.h.

contains()

bool OdSiShapeBoundPlane::contains ( const OdGeExtents3d &  extents, bool  planar, const OdGeTol &  tol  ) const

inlinevirtual

Checks if this shape bounded plane object contains the specified extents.

Parameters

extents	[in] Any 3D extents box.
planar	[in] Specifies whether a planar computation should be performed.
tol	[in] Tolerance.

Returns

false.

Implements OdSiShape.

Definition at line 80 of file SiShapeBoundPlane.h.

intersects()

bool OdSiShapeBoundPlane::intersects ( const OdGeExtents3d &  extents, bool  planar, const OdGeTol &  tol  ) const

inlinevirtual

Checks if this shape bounded plane object intersects the specified extents.

Parameters

extents	[in] Any 3D extents box.
planar	[in] Specifies whether a planar computation should be performed.
tol	[in] Tolerance.

Returns

true if and only if this shape bounded plane object intersects the specfied extents.

Implements OdSiShape.

Definition at line 94 of file SiShapeBoundPlane.h.

transform()

virtual void OdSiShapeBoundPlane::transform ( const OdGeMatrix3d &  tf )

inlinevirtual

Transforms this shape bounded plane object.

Parameters

tf	[in] Transformation matrix.

Reimplemented from OdSiShapePlane.

Definition at line 117 of file SiShapeBoundPlane.h.

Member Data Documentation

m_bounds

OdGeExtents3d OdSiShapeBoundPlane::m_bounds

Box bounding the plane.

Definition at line 44 of file SiShapeBoundPlane.h.

---

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

• SiShapeBoundPlane.h