CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Attributes | List of all members
OdGsCollisionDetectionContext Class Reference

#include <Gs.h>

Public Member Functions

 OdGsCollisionDetectionContext ()
 
void setIntersectionOnly (bool bSet)
 
bool intersectionOnly () const
 
void setIntersectionWithModel (bool bSet)
 
bool intersectionWithModel () const
 
void setIgnoreViewExtents (bool bSet)
 
bool ignoreViewExtents () const
 
void setCombineSubEntities (bool bSet)
 
bool combineSubEntities () const
 
void setToleranceOverride (const OdGeTol &tol)
 
bool isToleranceOverride () const
 
const OdGeToltoleranceOverride () const
 
void setCalculateDistance (bool bSet)
 
bool getCalculateDistance () const
 
void setCheckAll (bool bSet)
 
bool getCheckAll () const
 
void setClearance (double c)
 
double getClearance () const
 
void setProcessSignleList (bool bSet)
 
bool getProcessSignleList () const
 

Protected Types

enum  Options {
  kIntersectionOnly = 1 , kIntersectionWithModel = 1 << 1 , kIgnoreViewExtents = 1 << 2 , kCombineSubEntities = 1 << 3 ,
  kOverrideTolerance = 1 << 4 , kCalculateDistance = 1 << 5 , kCheckAll = 1 << 6 , kProcessSingleList = 1 << 7
}
 

Protected Attributes

OdUInt8 m_flags
 
OdGeTol m_tolerance
 
double m_clearance
 

Detailed Description

This class is the context for Collision Detection

See also
TD_Gs

<group OdGs_Classes>

Definition at line 1283 of file Gs.h.

Member Enumeration Documentation

◆ Options

Enumerator
kIntersectionOnly 
kIntersectionWithModel 
kIgnoreViewExtents 
kCombineSubEntities 
kOverrideTolerance 
kCalculateDistance 
kCheckAll 
kProcessSingleList 

Definition at line 1289 of file Gs.h.

Constructor & Destructor Documentation

◆ OdGsCollisionDetectionContext()

OdGsCollisionDetectionContext::OdGsCollisionDetectionContext ( )
inline

Default constructor for the OdGsCollisionDetectionContext class. Sets default tolerance value for geometric operations.

Definition at line 1306 of file Gs.h.

Member Function Documentation

◆ combineSubEntities()

bool OdGsCollisionDetectionContext::combineSubEntities ( ) const
inline

Retrives subentity markers ignoring.

Returns
Returns flag that indicates should subentities markers be ignored or not.

Definition at line 1355 of file Gs.h.

◆ getCalculateDistance()

bool OdGsCollisionDetectionContext::getCalculateDistance ( ) const
inline

Checks should collision detection calculate distances (penetration depth or distance between objects)

Returns
Returns flag that indicates should collision detection calculate distances or not.

Definition at line 1384 of file Gs.h.

◆ getCheckAll()

bool OdGsCollisionDetectionContext::getCheckAll ( ) const
inline

Checks that collision detection should check all faces instead of detecting first collision.

Returns
Returns flag that indicates should collision detection check all faces instead of detecting first collision.

Definition at line 1394 of file Gs.h.

◆ getClearance()

double OdGsCollisionDetectionContext::getClearance ( ) const
inline

Retrives collision detection clearance value.

Returns
Returns collision detection clearance value.

Definition at line 1404 of file Gs.h.

◆ getProcessSignleList()

bool OdGsCollisionDetectionContext::getProcessSignleList ( ) const
inline

Checks that collision detection should detects collisions between list and all other entities (false) or it should detect collisions between entities in list (true).

Returns
Returns flag that indicates should collision detection detect collisions between entities in list instead of between list and other entities.

Definition at line 1416 of file Gs.h.

◆ ignoreViewExtents()

bool OdGsCollisionDetectionContext::ignoreViewExtents ( ) const
inline

Checks whether collisions are detected even if objects are outside view extents.

Returns
true if collisions are detected even if objects are beyond view extents, false otherwise.

Definition at line 1345 of file Gs.h.

◆ intersectionOnly()

bool OdGsCollisionDetectionContext::intersectionOnly ( ) const
inline

Retrieves a flag that specifies whether collisions are detected only when objects intersect.

Returns
true if collisions are detected only when objects intersect or false when collisions can be detected via touches.

Definition at line 1319 of file Gs.h.

◆ intersectionWithModel()

bool OdGsCollisionDetectionContext::intersectionWithModel ( ) const
inline

Retrieves a flag that specifies whether collisions are detected only when objects intersect.

Returns
true if collisions are detected only when objects intersect or false when collisions can be detected via touches.

Definition at line 1332 of file Gs.h.

◆ isToleranceOverride()

bool OdGsCollisionDetectionContext::isToleranceOverride ( ) const
inline

Checks that collision detection should use custom tolerance.

Returns
Returns flag that indicates should collision detection use custom tolerance or not.

Definition at line 1369 of file Gs.h.

◆ setCalculateDistance()

void OdGsCollisionDetectionContext::setCalculateDistance ( bool  bSet)
inline

Specifies that collision detection should also calculate distances (penetration depth or distance between objects)

Parameters
bSet[in] If true, distances will be calculated.

Definition at line 1379 of file Gs.h.

◆ setCheckAll()

void OdGsCollisionDetectionContext::setCheckAll ( bool  bSet)
inline

Specifies that collision detection should check all faces instead of detecting first collision.

Parameters
bSet[in] If true, collision detection will check all faces instead of detecting first collision.

Definition at line 1389 of file Gs.h.

◆ setClearance()

void OdGsCollisionDetectionContext::setClearance ( double  c)
inline

Specifies collision detection clearance value.

Parameters
c[in] Collision detection clearance value.

Definition at line 1399 of file Gs.h.

◆ setCombineSubEntities()

void OdGsCollisionDetectionContext::setCombineSubEntities ( bool  bSet)
inline

Specifies subentity markers ignoring.

Parameters
bSet[in] If true, subentities markers will be ignored.

Definition at line 1350 of file Gs.h.

◆ setIgnoreViewExtents()

void OdGsCollisionDetectionContext::setIgnoreViewExtents ( bool  bSet)
inline

Specifies whether collisions should be detected despite objects are outside view extents.

Parameters
bSet[in] Flag that specifies whether to detected collisions even if objects are beyond view extents.

Definition at line 1338 of file Gs.h.

◆ setIntersectionOnly()

void OdGsCollisionDetectionContext::setIntersectionOnly ( bool  bSet)
inline

Sets flag that specifies whether collisions are detected only when objects intersect.

Parameters
bSet[in] Flag that specifies whether to detect collisions only when objects intersect. If set to false, collisions can be detected via touches (no intersections).

Definition at line 1312 of file Gs.h.

◆ setIntersectionWithModel()

void OdGsCollisionDetectionContext::setIntersectionWithModel ( bool  bSet)
inline

Sets flag that specifies whether collisions should be detected with a model.

Parameters
bSet[in] Flag that specifies whether to detected collisions with a model.

Definition at line 1325 of file Gs.h.

◆ setProcessSignleList()

void OdGsCollisionDetectionContext::setProcessSignleList ( bool  bSet)
inline

Specifies should collision detection detects collisions between list and all other entities (false) or it should detect collisions between entities in list (true).

Parameters
bSet[in] If true, collision detection will detect collisions between entities in list instead of between list and other entities.

Definition at line 1410 of file Gs.h.

◆ setToleranceOverride()

void OdGsCollisionDetectionContext::setToleranceOverride ( const OdGeTol tol)
inline

Specifies custom collision tolerance.

Parameters
tol[in] Collision tolerance

Definition at line 1360 of file Gs.h.

◆ toleranceOverride()

const OdGeTol & OdGsCollisionDetectionContext::toleranceOverride ( ) const
inline

Retrives custom collision detection tolerance.

Returns
Returns custom collision detection tolerance.

Definition at line 1374 of file Gs.h.

Member Data Documentation

◆ m_clearance

double OdGsCollisionDetectionContext::m_clearance
protected

Definition at line 1300 of file Gs.h.

◆ m_flags

OdUInt8 OdGsCollisionDetectionContext::m_flags
protected

Definition at line 1287 of file Gs.h.

◆ m_tolerance

OdGeTol OdGsCollisionDetectionContext::m_tolerance
protected

Definition at line 1288 of file Gs.h.


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