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

#include <Gs.h>

Public Types

enum  { kNotImplemented = 0x80000000 , kContinue = 0 , kBreak = 1 }
 

Public Member Functions

virtual OdUInt32 collisionDetected (const OdGiPathNode *, const OdGiPathNode *)
 
virtual OdUInt32 collisionDetected (const OdGiPathNode *pPathNode1, const OdGiPathNode *pPathNode2, double dDistance)
 

Detailed Description

This class is the base class for custom classes that receive notification of OdGs Collision Detection events.

Remarks
The default implementations of all methods in this class do nothing but return.

<group OdGs_Classes>

See also
<link gs_collision_detection, Work with Collision Detection>

Definition at line 1236 of file Gs.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kNotImplemented 
kContinue 
kBreak 

Definition at line 1239 of file Gs.h.

Member Function Documentation

◆ collisionDetected() [1/2]

virtual OdUInt32 OdGsCollisionDetectionReactor::collisionDetected ( const OdGiPathNode ,
const OdGiPathNode  
)
inlinevirtual

Notification function called whenever an collision detected.

Parameters
pPathNode1[in] Pointer to the OdGiPathNode object from OdGsView::collide input list
pPathNode2[in] Pointer to the OdGiPathNode object that collides with pathNode1
Remarks
Returns kContinue if the operation is to continue or kBreak to stop collision detection

Definition at line 1254 of file Gs.h.

◆ collisionDetected() [2/2]

virtual OdUInt32 OdGsCollisionDetectionReactor::collisionDetected ( const OdGiPathNode pPathNode1,
const OdGiPathNode pPathNode2,
double  dDistance 
)
inlinevirtual

Notification function called whenever an collision detected if distance calsulation is specified

Parameters
pPathNode1[in] Pointer to the OdGiPathNode object from OdGsView::collide input list
pPathNode2[in] Pointer to the OdGiPathNode object that collides with pathNode1
dDistace[in] Collision distance. If negative, it is the penetration depth. If positive, it is the clearance.
Remarks
Returns kContinue if the operation is to continue or kBreak to stop collision detection

Definition at line 1269 of file Gs.h.


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