Public Member Functions | Protected Member Functions | Protected Attributes
Collider Class Reference

#include <OPC_Collider.h>

Inheritance diagram for Collider:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Collider ()
inline_ BOOL ContactFound () const
inline_ BOOL FirstContactEnabled () const
inline_ BOOL GetContactStatus () const
inline_ void SetFirstContact (bool flag)
inline_ void SetPrimitiveTests (bool flag)
inline_ void SetTemporalCoherence (bool flag)
inline_ BOOL SkipPrimitiveTests () const
inline_ BOOL TemporalCoherenceEnabled () const
inline_ BOOL TemporalHit () const
virtual const char * ValidateSettings ()=0
virtual ~Collider ()

Protected Member Functions

virtual inline_ void InitQuery ()
inline_ BOOL Setup (const BaseModel *model)

Protected Attributes

const BaseModelmCurrentModel
 Current model for collision query (owner of touched faces)
udword mFlags
 Bit flags.
const MeshInterfacemIMesh
 User-defined mesh interface.

Detailed Description

Contains the abstract class for colliders.

Author:
Pierre Terdiman
Version:
1.3
Date:
June, 2, 2001

Definition at line 37 of file OPC_Collider.h.


Constructor & Destructor Documentation

virtual Collider::~Collider ( ) [virtual]

Member Function Documentation

inline_ BOOL Collider::ContactFound ( ) const [inline]

Checks a first contact has already been found.

Returns:
true if a first contact has been found and we can stop a query

Definition at line 76 of file OPC_Collider.h.

Gets the "first contact" mode.

Returns:
true if "first contact" mode is on

Definition at line 60 of file OPC_Collider.h.

Gets the last collision status after a collision query.

Returns:
true if a collision occured

Definition at line 52 of file OPC_Collider.h.

virtual inline_ void Collider::InitQuery ( ) [inline, protected, virtual]

Initializes a query

Definition at line 173 of file OPC_Collider.h.

inline_ void Collider::SetFirstContact ( bool  flag) [inline]

Reports all contacts (false) or first contact only (true)

Parameters:
flag[in] true for first contact, false for all contacts
See also:
SetTemporalCoherence(bool flag)
ValidateSettings()

Definition at line 104 of file OPC_Collider.h.

inline_ void Collider::SetPrimitiveTests ( bool  flag) [inline]

Enable/disable primitive tests.

Parameters:
flag[in] true to enable primitive tests, false to discard them

Definition at line 130 of file OPC_Collider.h.

inline_ void Collider::SetTemporalCoherence ( bool  flag) [inline]

Enable/disable temporal coherence.

Parameters:
flag[in] true to enable temporal coherence, false to discard it
See also:
SetFirstContact(bool flag)
ValidateSettings()

Definition at line 118 of file OPC_Collider.h.

inline_ BOOL Collider::Setup ( const BaseModel model) [inline, protected]

Setups current collision model

Parameters:
model[in] current collision model
Returns:
TRUE if success

Definition at line 158 of file OPC_Collider.h.

Checks primitive tests are enabled;

Returns:
true if primitive tests must be skipped

Definition at line 92 of file OPC_Collider.h.

Gets the temporal coherence mode.

Returns:
true if temporal coherence is on

Definition at line 68 of file OPC_Collider.h.

inline_ BOOL Collider::TemporalHit ( ) const [inline]

Checks there's been an early exit due to temporal coherence;

Returns:
true if a temporal hit has occured

Definition at line 84 of file OPC_Collider.h.

virtual const char* Collider::ValidateSettings ( ) [pure virtual]

Validates current settings. You should call this method after all the settings / callbacks have been defined for a collider.

Returns:
null if everything is ok, else a string describing the problem

Member Data Documentation

Current model for collision query (owner of touched faces)

Definition at line 146 of file OPC_Collider.h.

udword Collider::mFlags [protected]

Bit flags.

Definition at line 145 of file OPC_Collider.h.

User-defined mesh interface.

Definition at line 148 of file OPC_Collider.h.


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


openhrp3
Author(s): AIST, General Robotix Inc., Nakamura Lab of Dept. of Mechano Informatics at University of Tokyo
autogenerated on Thu Apr 11 2019 03:30:21