physics::SimpleCollisionCuller Class Reference

Inheritance diagram for physics::SimpleCollisionCuller:

[legend]Collaboration diagram for physics::SimpleCollisionCuller:

[legend]List of all members.


Public Types
typedef Int	Attributes
typedef Int	VisualType
enum	AttributeFlags { ShowAxes = 1, ShowBounds = 2, ShowCollisions = 4, ShowCollisionModel = 8, ShowCollisionDetection = 16, ShowEdges = 32, ShowNormals = 64, VerticesOnly = 128 }
Public Member Functions
	SimpleCollisionCuller ()
virtual	~SimpleCollisionCuller ()
virtual String	className () const
virtual ref< CollidableGroup >	createCollidableGroup () const
virtual void	collide (ref< const Collidable > collidable1, ref< const Collidable > collidable2)
	notify PotentialCollisionListeners if possible collision between Collidables
virtual void	collide (ref< const Collidable > collidable)
virtual void	collisionEnable (bool enabled, ref< const Collidable > collidable1, ref< const Collidable > collidable2)
virtual void	collisionEnable (bool enabled)
	enable/disable all collisions
virtual bool	isCollisionEnabled (ref< const Collidable > collidable1, ref< const Collidable > collidable2)
virtual bool	isCollisionEnabled () const
virtual void	reset ()
	called at the beginning of each collision cycle
virtual void	addPotentialCollisionListener (ref< PotentialCollisionListener > listener)
virtual void	removePotentialCollisionListener (ref< PotentialCollisionListener > listener)
virtual void	potentialCollision (ref< const Collidable > collidable1, ref< const Collidable > collidable2)
virtual bool	visualTypeSupported (VisualType type) const
virtual osg::Node *	createOSGVisual (Visual::Attributes visualAttributes=0) const
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Static Public Attributes
const Int	OSGVisual = 1
Protected Types
typedef std::pair< ref< const Collidable >, ref< const Collidable > >	CollidablePair
typedef std::map< CollidablePair, bool >	CollisionDisabledMap
typedef base::reflist< PotentialCollisionListener >	ListenerList
Protected Member Functions
	SimpleCollisionCuller (const SimpleCollisionCuller &cc)
void	notifyListeners (ref< const Collidable > collidable1, ref< const Collidable > collidable2)
	call potentialCollision(collidable1,collidable2) on all listeners (if enabled)
void	resetListeners ()
	call reset() on all listeners (if enabled)
Protected Attributes
CollisionDisabledMap	collisionDisabledMap
bool	enabled
ListenerList	listeners
int	_refCount
bool	onUnreferenceEnabled

Detailed Description

Simple Collider that only culls Collidable pairs that have been disabled (also flattens a heirarchy of Collidable/CollidableGroups into a flat set of CollidableBodys) i.e. listeners will only be called with CollidableBodys, no CollidableGroups will be passed through - instead all combinations of pairs of CollidableBodys from any group will be passed. This is useful to pass to a CollisionDetector, which only accepts CollidableBodys.

Definition at line 42 of file SimpleCollisionCuller.

Member Typedef Documentation

typedef Int gfx::Visual::Attributes [inherited]

Definition at line 39 of file Visual.
Referenced by gfx::Visual::createOSGVisual().

typedef std::pair< ref<const Collidable>, ref<const Collidable> > physics::CollisionCuller::CollidablePair [protected, inherited]

Definition at line 78 of file CollisionCuller.
Referenced by physics::CollisionCuller::collisionEnable(), and physics::CollisionCuller::isCollisionEnabled().

typedef std::map< CollidablePair, bool > physics::CollisionCuller::CollisionDisabledMap [protected, inherited]

Definition at line 79 of file CollisionCuller.

typedef base::reflist<PotentialCollisionListener> physics::Collider::ListenerList [protected, inherited]

Definition at line 76 of file Collider.

typedef Int gfx::Visual::VisualType [inherited]

Definition at line 44 of file Visual.
Referenced by gfx::Visual::visualTypeSupported().

Member Enumeration Documentation

enum gfx::Visual::AttributeFlags [inherited]

Enumeration values:

ShowAxes

ShowBounds

ShowCollisions

ShowCollisionModel

ShowCollisionDetection

ShowEdges

ShowNormals

VerticesOnly

Definition at line 40 of file Visual.

Constructor & Destructor Documentation

physics::SimpleCollisionCuller::SimpleCollisionCuller ( ) [inline]

Definition at line 45 of file SimpleCollisionCuller.

virtual physics::SimpleCollisionCuller::~SimpleCollisionCuller ( ) [inline, virtual]

Definition at line 46 of file SimpleCollisionCuller.

physics::SimpleCollisionCuller::SimpleCollisionCuller ( const SimpleCollisionCuller & cc ) [inline, protected]

Definition at line 57 of file SimpleCollisionCuller.

Member Function Documentation

virtual void physics::Collider::addPotentialCollisionListener ( ref< PotentialCollisionListener > listener ) [inline, virtual, inherited]

Definition at line 60 of file Collider.
References base::reflist< _Tp, _Alloc >::push_back().

virtual String physics::SimpleCollisionCuller::className ( ) const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes.
Implements base::Object.
Definition at line 48 of file SimpleCollisionCuller.

virtual void physics::SimpleCollisionCuller::collide ( ref< const Collidable > collidable ) [inline, virtual]

convenience method that calls collide(collidable1, collidable2) for each pair of Collidables in the group collidable, unless collidable isn't a group or has child inter-collision disabled (so that you can keep all your Collidables in a single top-level group)
Reimplemented from physics::Collider.
Definition at line 54 of file SimpleCollisionCuller.

virtual void physics::SimpleCollisionCuller::collide ( ref< const Collidable > collidable1,

ref< const Collidable > collidable2

) [virtual]

notify PotentialCollisionListeners if possible collision between Collidables

Implements physics::Collider.

virtual void physics::CollisionCuller::collisionEnable ( bool enabled ) [inline, virtual, inherited]

enable/disable all collisions

Reimplemented from physics::Collider.
Definition at line 69 of file CollisionCuller.

virtual void physics::CollisionCuller::collisionEnable ( bool enabled,

ref< const Collidable > collidable1,

ref< const Collidable > collidable2

) [inline, virtual, inherited]

Definition at line 42 of file CollisionCuller.
References physics::CollisionCuller::CollidablePair, physics::CollisionCuller::collisionDisabledMap, and base::swap().

virtual ref<CollidableGroup> physics::SimpleCollisionCuller::createCollidableGroup ( ) const [inline, virtual]

Implements physics::CollisionCuller.
Definition at line 50 of file SimpleCollisionCuller.
References NewObj.

virtual osg::Node* gfx::Visual::createOSGVisual ( Visual::Attributes visualAttributes = 0 ) const [inline, virtual, inherited]

Reimplemented in physics::GJKCollisionDetector, physics::OBBCollisionModel, physics::ODECollisionModel, physics::ODESolidSystem, physics::Solid, physics::SOLIDCollisionModel, and robot::sim::SimulatedBasicEnvironment.
Definition at line 49 of file Visual.
References gfx::Visual::Attributes, Logln, and NewObj.

void base::Referenced::enableOnUnreferenceCall ( bool enabled ) [inline, inherited]

If enabled, each call to unreference() will also call virtual method onUnreference()
Definition at line 115 of file Referenced.
References base::Referenced::onUnreferenceEnabled.

virtual bool physics::CollisionCuller::isCollisionEnabled ( ) const [inline, virtual, inherited]

Reimplemented from physics::Collider.
Definition at line 70 of file CollisionCuller.

virtual bool physics::CollisionCuller::isCollisionEnabled ( ref< const Collidable > collidable1,

ref< const Collidable > collidable2

) [inline, virtual, inherited]

Definition at line 51 of file CollisionCuller.
References physics::CollisionCuller::CollidablePair, physics::CollisionCuller::collisionDisabledMap, and base::swap().

virtual bool base::Object::isSameKindAs ( const Object & ) const [inline, virtual, inherited]

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs ( const ReferencedObject & ) const [inline, virtual, inherited]

Definition at line 52 of file ReferencedObject.

void physics::Collider::notifyListeners ( ref< const Collidable > collidable1,

ref< const Collidable > collidable2

) [protected, inherited]

call potentialCollision(collidable1,collidable2) on all listeners (if enabled)

virtual void base::Referenced::onUnreference ( ) const [inline, virtual, inherited]

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references
Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface, and robot::control::ControllableAdaptor.
Definition at line 121 of file Referenced.
Referenced by base::Referenced::unreference().

virtual void physics::Collider::potentialCollision ( ref< const Collidable > collidable1,

ref< const Collidable > collidable2

) [inline, virtual, inherited]

Implements physics::PotentialCollisionListener.
Definition at line 66 of file Collider.
References physics::Collider::collide().

void base::Referenced::reference ( ) const [inline, inherited]

Increment the reference count by one, indicating that this object has another pointer which is referencing it.
Definition at line 65 of file Referenced.
References base::Referenced::_refCount.

const int base::Referenced::referenceCount ( ) const [inline, inherited]

Return the number pointers currently referencing this object.
Definition at line 112 of file Referenced.
References base::Referenced::_refCount.
Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference().

virtual void physics::Collider::removePotentialCollisionListener ( ref< PotentialCollisionListener > listener ) [inline, virtual, inherited]

Definition at line 63 of file Collider.
References base::reflist< _Tp, _Alloc >::remove().

virtual void physics::Collider::reset ( ) [inline, virtual, inherited]

called at the beginning of each collision cycle

Reimplemented from physics::PotentialCollisionListener.
Reimplemented in physics::SolidCollisionResponseHandler, and robot::sim::SimulatedKinematicChain::ProximityCollisionResponseHandler.
Definition at line 46 of file Collider.
References physics::Collider::resetListeners().

void physics::Collider::resetListeners ( ) [protected, inherited]

call reset() on all listeners (if enabled)

Referenced by physics::Collider::reset().

bool base::Referenced::unreference ( ) const [inline, inherited]

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted.
Definition at line 81 of file Referenced.
References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.