gfx::OSGWorld Class Reference

Inheritance diagram for gfx::OSGWorld:

[legend]Collaboration diagram for gfx::OSGWorld:

[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
	OSGWorld (ref< base::VFileSystem > fs, ref< base::Cache > cache, const String &name="")
	OSGWorld (const OSGWorld &w)
virtual String	className () const
virtual bool	visualTypeSupported (VisualType type) 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
virtual osg::Node *	createOSGVisual (Visual::Attributes visualAttributes=0) const
Static Public Attributes
const Int	OSGVisual = 1
Protected Member Functions
virtual void	setName (const String &name)
Protected Attributes
ref< base::VFileSystem >	vfilesystem
ref< base::Cache >	theCache
int	_refCount
bool	onUnreferenceEnabled

Detailed Description

A 3D World represented using Open Scene Graph (OSG)

Definition at line 41 of file OSGWorld.

Member Typedef Documentation

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

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

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

gfx::OSGWorld::OSGWorld ( ref< base::VFileSystem > fs,

ref< base::Cache > cache,

const String & name = ""

)

gfx::OSGWorld::OSGWorld ( const OSGWorld & w ) [inline]

Definition at line 45 of file OSGWorld.

Member Function Documentation

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

Definition at line 51 of file World.
References base::World::theCache.

virtual String gfx::OSGWorld::className ( ) const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes.
Reimplemented from base::World.
Reimplemented in robot::sim::SimulatedBasicEnvironment.
Definition at line 47 of file OSGWorld.

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.

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

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, inherited]

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.

virtual bool gfx::OSGWorld::visualTypeSupported ( VisualType type ) const [inline, virtual]

Reimplemented from gfx::Visual.
Definition at line 49 of file OSGWorld.