OdSiShapeRay Struct Reference

#include <SiShapeRay.h>

Inheritance diagram for OdSiShapeRay:

Public Member Functions
	OdSiShapeRay (const OdGePoint3d &pointStart, const OdGeVector3d &vecDir)
	OdSiShapeRay (const OdGeRay3d &ray)
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 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
OdGePoint3d	m_pointStart
OdGeVector3d	m_vecDir

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 ray implementation for OdSiShape interface.

Corresponding C++ library: SpatialIndex <group OdSi_Classes>

Definition at line 40 of file SiShapeRay.h.

Constructor & Destructor Documentation

OdSiShapeRay() [1/2]

OdSiShapeRay::OdSiShapeRay ( const OdGePoint3d &  pointStart, const OdGeVector3d &  vecDir  )

inline

Creates a new instance of a shape ray.

Parameters

pointStart	[in] A 3D point from which the ray is casted.
vecDir	[in] The direction of ray.

Definition at line 54 of file SiShapeRay.h.

OdSiShapeRay() [2/2]

OdSiShapeRay::OdSiShapeRay ( const OdGeRay3d &  ray )

inline

Creates a new instance of a shape ray.

Parameters

ray

[in] Ray.

Definition at line 65 of file SiShapeRay.h.

Member Function Documentation

clone()

virtual OdSiShape * OdSiShapeRay::clone ( ) const

inlinevirtual

Clones this shape ray object.

Returns

a pointer to the newly created shape object.

Reimplemented from OdSiShape.

Definition at line 185 of file SiShapeRay.h.

contains()

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

inlinevirtual

Checks if this shape ray 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 83 of file SiShapeRay.h.

intersects()

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

inlinevirtual

Checks if this shape ray 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 ray object intersects the specfied extents.

Implements OdSiShape.

Definition at line 96 of file SiShapeRay.h.

transform()

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

inlinevirtual

Transforms this shape ray object.

Parameters

tf	[in] Transformation matrix.

Reimplemented from OdSiShape.

Definition at line 192 of file SiShapeRay.h.

Member Data Documentation

m_pointStart

OdGePoint3d OdSiShapeRay::m_pointStart

Ray starting point

Definition at line 43 of file SiShapeRay.h.

m_vecDir

OdGeVector3d OdSiShapeRay::m_vecDir

Ray direction

Definition at line 46 of file SiShapeRay.h.

---

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

• SiShapeRay.h