base::World Class Reference

Inheritance diagram for base::World:

[legend]Collaboration diagram for base::World:

[legend]List of all members.

Public Member Functions
	World (ref< base::VFileSystem > fs, ref< base::Cache > cache, const String &name="")
	World (const World &w)
virtual	~World ()
virtual String	className () const
ref< base::Cache >	cache () const
ref< base::VFileSystem >	filesystem () const
virtual void	renderFrame ()
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
virtual const String &	getName () const
Protected Member Functions
virtual void	setName (const String &name)
Protected Attributes
ref< base::VFileSystem >	vfilesystem
ref< base::Cache >	theCache
int	_refCount
bool	onUnreferenceEnabled

---

Constructor & Destructor Documentation

base::World::World (  ref< base::VFileSystem >  fs, ref< base::Cache >  cache, const String &  name = "" )  [inline]

Definition at line 43 of file World. References base::String, and theCache.

base::World::World (  const World &  w  )  [inline]

Definition at line 45 of file World. References theCache.

virtual base::World::~World (   )  [inline, virtual]

Definition at line 47 of file World.

---

Member Function Documentation

ref<base::Cache> base::World::cache (   )  const [inline]

Definition at line 51 of file World. References theCache.

virtual String base::World::className (   )  const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes. Implements base::Object. Reimplemented in gfx::OSGWorld, and robot::sim::SimulatedBasicEnvironment. Definition at line 49 of file World. References base::String.

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.

ref<base::VFileSystem> base::World::filesystem (   )  const [inline]

Definition at line 52 of file World.

virtual const String& base::Named::getName (   )  const [inline, virtual, inherited]

Definition at line 44 of file Named. References base::String. Referenced by physics::Collidable::findNamed(), physics::operator<<(), robot::ToolDescription::operator=(), robot::RobotDescription::operator=(), robot::PlatformDescription::operator=(), robot::ManipulatorDescription::operator=(), base::Named::operator=(), and robot::ManipulatorDescription::operator==().

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.

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().

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 base::World::renderFrame (   )  [inline, virtual]

Definition at line 54 of file World.

virtual void base::Named::setName (  const String &  name  )  [inline, protected, virtual, inherited]

Reimplemented in physics::Collidable, physics::Solid, and robot::sim::BasicEnvironment::Obstacle. Definition at line 47 of file Named. References base::String. Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::AdaptorControlInterface(), robot::control::kinematics::BetaFormConstraints::BetaFormConstraint::BetaFormConstraint(), robot::control::kinematics::IKORController::EEPositionControlInterface::EEPositionControlInterface(), robot::control::kinematics::IKOR::JointLimitBetaConstraint::JointLimitBetaConstraint(), robot::control::kinematics::IKORController::LinkPositionsControlInterface::LinkPositionsControlInterface(), robot::ToolDescription::operator=(), robot::RobotDescription::operator=(), robot::PlatformDescription::operator=(), robot::ManipulatorDescription::operator=(), base::Named::operator=(), robot::control::ManipulatorPIDPositionController::PositionInterface::PositionInterface(), robot::RobotDescription::set(), robot::PlatformDescription::set(), robot::ManipulatorDescription::set(), and physics::Solid::setName().

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.

---

Member Data Documentation

int base::Referenced::_refCount [mutable, protected, inherited]

Definition at line 136 of file Referenced. Referenced by base::Referenced::reference(), base::Referenced::referenceCount(), base::Referenced::Referenced(), base::Referenced::unreference(), and base::Referenced::~Referenced().

bool base::Referenced::onUnreferenceEnabled [protected, inherited]

Definition at line 137 of file Referenced. Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().

ref<base::Cache> base::World::theCache [protected]

Definition at line 58 of file World. Referenced by cache(), and World().

ref<base::VFileSystem> base::World::vfilesystem [protected]

Definition at line 57 of file World.

---

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

• base/World

---