Irrlicht 3D Engine
irr::scene::ISceneNodeAnimatorCollisionResponse Class Referenceabstract

Special scene node animator for doing automatic collision detection and response. More...

#include <ISceneNodeAnimatorCollisionResponse.h>

+ Inheritance diagram for irr::scene::ISceneNodeAnimatorCollisionResponse:

Public Member Functions

virtual ~ISceneNodeAnimatorCollisionResponse ()
 Destructor. More...
 
virtual bool collisionOccurred () const =0
 Returns true if a collision occurred during the last animateNode() More...
 
virtual bool getAnimateTarget () const =0
 
virtual ISceneNodegetCollisionNode (void) const =0
 Returns the node that was collided with. More...
 
virtual const core::vector3dfgetCollisionPoint () const =0
 Returns the last point of collision. More...
 
virtual const core::vector3dfgetCollisionResultPosition (void) const =0
 Returns the position that the target node will be moved to, unless the collision is consumed in a callback. More...
 
virtual const core::triangle3dfgetCollisionTriangle () const =0
 Returns the last triangle that caused a collision. More...
 
virtual core::vector3df getEllipsoidRadius () const =0
 Returns the radius of the ellipsoid for collision detection and response. More...
 
virtual core::vector3df getEllipsoidTranslation () const =0
 Get the translation of the ellipsoid for collision detection. More...
 
*virtual core::vector3df getGravity () const =0
 
virtual ISceneNodegetTargetNode (void) const =0
 Gets the single node that this animator is acting on. More...
 
virtual ITriangleSelectorgetWorld () const =0
 Get the current triangle selector containing all triangles for collision detection. More...
 
virtual bool isFalling () const =0
 Check if the attached scene node is falling. More...
 
virtual void jump (f32 jumpSpeed)=0
 'Jump' the animator, by adding a jump speed opposite to its gravity More...
 
virtual void setAnimateTarget (bool enable)=0
 Should the Target react on collision ( default = true ) More...
 
virtual void setCollisionCallback (ICollisionCallback *callback)=0
 Sets a callback interface which will be called if a collision occurs. More...
 
virtual void setEllipsoidRadius (const core::vector3df &radius)=0
 Sets the radius of the ellipsoid for collision detection and response. More...
 
virtual void setEllipsoidTranslation (const core::vector3df &translation)=0
 Set translation of the collision ellipsoid. More...
 
virtual void setGravity (const core::vector3df &gravity)=0
 Sets the gravity of the environment. More...
 
virtual void setTargetNode (ISceneNode *node)=0
 Set the single node that this animator will act on. More...
 
virtual void setWorld (ITriangleSelector *newWorld)=0
 Sets a triangle selector holding all triangles of the world with which the scene node may collide. More...
 
- Public Member Functions inherited from irr::scene::ISceneNodeAnimator
virtual void animateNode (ISceneNode *node, u32 timeMs)=0
 Animates a scene node. More...
 
virtual ISceneNodeAnimatorcreateClone (ISceneNode *node, ISceneManager *newManager=0)=0
 Creates a clone of this animator. More...
 
virtual ESCENE_NODE_ANIMATOR_TYPE getType () const
 Returns type of the scene node animator. More...
 
virtual bool hasFinished (void) const
 Returns if the animator has finished. More...
 
virtual bool isEventReceiverEnabled () const
 Returns true if this animator receives events. More...
 
virtual bool OnEvent (const SEvent &event)
 Event receiver, override this function for camera controlling animators. More...
 
- Public Member Functions inherited from irr::io::IAttributeExchangingObject
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
 Reads attributes of the object. More...
 
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
 Writes attributes of the object. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
- Public Member Functions inherited from irr::IEventReceiver
virtual ~IEventReceiver ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

Special scene node animator for doing automatic collision detection and response.

This scene node animator can be attached to any single scene node and will then prevent it from moving through specified collision geometry (e.g. walls and floors of the) world, as well as having it fall under gravity. This animator provides a simple implementation of first person shooter cameras. Attach it to a camera, and the camera will behave as the player control in a first person shooter game: The camera stops and slides at walls, walks up stairs, falls down if there is no floor under it, and so on.

The animator will treat any change in the position of its target scene node as movement, including a setPosition(), as movement. If you want to teleport the target scene node manually to a location without it being effected by collision geometry, then call setTargetNode(node) after calling node->setPosition().

Definition at line 53 of file ISceneNodeAnimatorCollisionResponse.h.

Constructor & Destructor Documentation

§ ~ISceneNodeAnimatorCollisionResponse()

virtual irr::scene::ISceneNodeAnimatorCollisionResponse::~ISceneNodeAnimatorCollisionResponse ( )
inlinevirtual

Destructor.

Definition at line 58 of file ISceneNodeAnimatorCollisionResponse.h.

Member Function Documentation

§ collisionOccurred()

virtual bool irr::scene::ISceneNodeAnimatorCollisionResponse::collisionOccurred ( ) const
pure virtual

Returns true if a collision occurred during the last animateNode()

§ getAnimateTarget()

virtual bool irr::scene::ISceneNodeAnimatorCollisionResponse::getAnimateTarget ( ) const
pure virtual

§ getCollisionNode()

virtual ISceneNode* irr::scene::ISceneNodeAnimatorCollisionResponse::getCollisionNode ( void  ) const
pure virtual

Returns the node that was collided with.

§ getCollisionPoint()

virtual const core::vector3df& irr::scene::ISceneNodeAnimatorCollisionResponse::getCollisionPoint ( ) const
pure virtual

Returns the last point of collision.

§ getCollisionResultPosition()

virtual const core::vector3df& irr::scene::ISceneNodeAnimatorCollisionResponse::getCollisionResultPosition ( void  ) const
pure virtual

Returns the position that the target node will be moved to, unless the collision is consumed in a callback.

If you have a collision callback registered, and it consumes the collision, then the node will ignore the collision and will not stop at this position. Instead, it will move fully to the position that caused the collision to occur.

§ getCollisionTriangle()

virtual const core::triangle3df& irr::scene::ISceneNodeAnimatorCollisionResponse::getCollisionTriangle ( ) const
pure virtual

Returns the last triangle that caused a collision.

§ getEllipsoidRadius()

virtual core::vector3df irr::scene::ISceneNodeAnimatorCollisionResponse::getEllipsoidRadius ( ) const
pure virtual

Returns the radius of the ellipsoid for collision detection and response.

Returns
Radius of the ellipsoid.

§ getEllipsoidTranslation()

virtual core::vector3df irr::scene::ISceneNodeAnimatorCollisionResponse::getEllipsoidTranslation ( ) const
pure virtual

Get the translation of the ellipsoid for collision detection.

See ISceneNodeAnimatorCollisionResponse::setEllipsoidTranslation() for more details.

Returns
Translation of the ellipsoid relative to the position of the scene node.

§ getGravity()

* virtual core::vector3df irr::scene::ISceneNodeAnimatorCollisionResponse::getGravity ( ) const
pure virtual

Get current vector of gravity.

Returns
Gravity vector.

§ getTargetNode()

virtual ISceneNode* irr::scene::ISceneNodeAnimatorCollisionResponse::getTargetNode ( void  ) const
pure virtual

Gets the single node that this animator is acting on.

Returns
The node that this animator is acting on.

§ getWorld()

virtual ITriangleSelector* irr::scene::ISceneNodeAnimatorCollisionResponse::getWorld ( ) const
pure virtual

Get the current triangle selector containing all triangles for collision detection.

§ isFalling()

virtual bool irr::scene::ISceneNodeAnimatorCollisionResponse::isFalling ( ) const
pure virtual

Check if the attached scene node is falling.

Falling means that there is no blocking wall from the scene node in the direction of the gravity. The implementation of this method is very fast, no collision detection is done when invoking it.

Returns
True if the scene node is falling, false if not.

§ jump()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::jump ( f32  jumpSpeed)
pure virtual

'Jump' the animator, by adding a jump speed opposite to its gravity

Parameters
jumpSpeedThe initial speed of the jump; the velocity will be opposite to this animator's gravity vector.

§ setAnimateTarget()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setAnimateTarget ( bool  enable)
pure virtual

Should the Target react on collision ( default = true )

§ setCollisionCallback()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setCollisionCallback ( ICollisionCallback callback)
pure virtual

Sets a callback interface which will be called if a collision occurs.

Parameters
callbackcollision callback handler that will be called when a collision occurs. Set this to 0 to disable the callback.

§ setEllipsoidRadius()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setEllipsoidRadius ( const core::vector3df radius)
pure virtual

Sets the radius of the ellipsoid for collision detection and response.

If you have a scene node, and you are unsure about how big the radius should be, you could use the following code to determine it:

core::aabbox<f32> box = yourSceneNode->getBoundingBox();
core::vector3df radius = box.MaxEdge - box.getCenter();
Parameters
radiusNew radius of the ellipsoid.

§ setEllipsoidTranslation()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setEllipsoidTranslation ( const core::vector3df translation)
pure virtual

Set translation of the collision ellipsoid.

By default, the ellipsoid for collision detection is created around the center of the scene node, which means that the ellipsoid surrounds it completely. If this is not what you want, you may specify a translation for the ellipsoid.

Parameters
translationTranslation of the ellipsoid relative to the position of the scene node.

§ setGravity()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setGravity ( const core::vector3df gravity)
pure virtual

Sets the gravity of the environment.

A good example value would be core::vector3df(0,-100.0f,0) for letting gravity affect all object to fall down. For bigger gravity, make increase the length of the vector. You can disable gravity by setting it to core::vector3df(0,0,0);

Parameters
gravityNew gravity vector.

§ setTargetNode()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setTargetNode ( ISceneNode node)
pure virtual

Set the single node that this animator will act on.

Parameters
nodeThe new target node. Setting this will force the animator to update its last target position for the node, allowing setPosition() to teleport the node through collision geometry.

§ setWorld()

virtual void irr::scene::ISceneNodeAnimatorCollisionResponse::setWorld ( ITriangleSelector newWorld)
pure virtual

Sets a triangle selector holding all triangles of the world with which the scene node may collide.

Parameters
newWorldNew triangle selector containing triangles to let the scene node collide with.

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