Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::physics::context::PhysicsSceneObject Class Reference

An interface for classes that can be part of a physics scene. More...

#include <omPhysicsSceneObject.h>

Inheritance diagram for om::physics::context::PhysicsSceneObject:
om::physics::context::PhysicsContextObject om::physics::constraints::Constraint om::physics::forces::Force om::physics::objects::PhysicsObject om::physics::constraints::ContactConstraint om::physics::constraints::SphericalJoint om::physics::forces::ForceField om::physics::forces::Spring om::physics::forces::Thruster om::physics::objects::CharacterController om::physics::objects::RigidObject om::physics::forces::GravityField

Public Member Functions

virtual Bool addSceneObjects (PhysicsSceneID sceneID)
 Add internal context objects to the scene with the specified ID. More...
 
virtual Bool removeSceneObjects (PhysicsSceneID sceneID)
 Remove internal context objects from the scene with the specified ID. More...
 
- Public Member Functions inherited from om::physics::context::PhysicsContextObject
virtual ~PhysicsContextObject ()
 Destory this physics context object. More...
 
PhysicsContextgetContext () const
 Return a pointer to the physics context this context object is using to do simulation. More...
 
virtual Bool setContext (PhysicsContext *newContext)
 Set a pointer to the physics context this context object should use to do simulation. More...
 
Bool clearContext ()
 Clear the previous context from this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from om::physics::context::PhysicsContextObject
 PhysicsContextObject ()
 Create a new physics context object that doesn't have an associated physics context. More...
 
 PhysicsContextObject (PhysicsContext *newContext)
 Create a new physics context object that uses the specified context for simulation. More...
 
- Protected Attributes inherited from om::physics::context::PhysicsContextObject
PhysicsContextcontext
 A pointer to the physics context this object is using. More...
 

Detailed Description

An interface for classes that can be part of a physics scene.

Member Function Documentation

virtual Bool om::physics::context::PhysicsSceneObject::addSceneObjects ( PhysicsSceneID  sceneID)
inlinevirtual

Add internal context objects to the scene with the specified ID.

This method should register any internal simulation objects as part of the given scene in the current simulation context. The method returns whether or not the objects where successfully registered.

virtual Bool om::physics::context::PhysicsSceneObject::removeSceneObjects ( PhysicsSceneID  sceneID)
inlinevirtual

Remove internal context objects from the scene with the specified ID.

This method should un-register any internal simulation objects from the given scene in the current simulation context. The method returns whether or not the objects where successfully unregistered.


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