physics::Spatial Class Reference

base class for things and collections thereof that can be positioned and oriented in 3D space More...

Inheritance diagram for physics::Spatial:

[legend]Collaboration diagram for physics::Spatial:

[legend]List of all members.

Public Member Functions
	Spatial ()
	Spatial (const String &name)
	Spatial (const Spatial &s)
virtual Spatial &	operator= (const Spatial &s)
virtual	~Spatial ()
virtual void	setPositionOrientation (const Point3 &pos, const Orient &orient)
virtual void	setConfiguration (const base::Transform &configuration)
virtual base::Transform	getConfiguration () const
virtual void	setPosition2D (const base::Point2 &p, Real theta)
	set the 2D (x,y,theta) position (theta is rot. angle about Z-axis)
virtual base::Point2	getPosition2D () const
	get the 2D (x,y) position
Real	getOrientation2D () const
	get the 2D angle theta (rot. angle about Z-axis)
virtual void	setPosition (const Point3 &pos)=0
virtual Point3	getPosition () const=0
virtual void	setOrientation (const Orient &orient)=0
virtual Orient	getOrientation () const=0
virtual const String &	getName () const
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
virtual String	className () const=0
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Protected Member Functions
virtual void	setName (const String &name)
Protected Attributes
int	_refCount
bool	onUnreferenceEnabled

---

Detailed Description

base class for things and collections thereof that can be positioned and oriented in 3D space

Definition at line 38 of file Spatial.

---

Constructor & Destructor Documentation

physics::Spatial::Spatial (   )  [inline]

Definition at line 41 of file Spatial.

physics::Spatial::Spatial (  const String &  name  )  [inline]

Definition at line 42 of file Spatial.

physics::Spatial::Spatial (  const Spatial &  s  )  [inline]

Definition at line 43 of file Spatial.

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

Definition at line 47 of file Spatial.

---

Member Function Documentation

virtual String base::Object::className (   )  const [pure virtual, inherited]

return the name of the object's class type. Must be defined by derived classes. Implemented in base::Application, base::BinarySerializer, base::Cache, base::CacheDirectory, base::CacheFile, base::ConstantExpression, base::CosExpression, base::DifferenceExpression, base::Directory, base::Expression, base::Externalizer, base::File, base::LineSegPathRep, base::LineSegTrajectoryRep, base::Math, base::NegateExpression, base::ParametricPathRep, base::ParametricTrajectoryRep, base::Path, base::PathComponent, base::PathName, base::ProductExpression, base::QuotientExpression, base::SimpleXMLSerializer, base::SinExpression, base::StdFileSystem, base::SumExpression, base::Time, base::Trajectory, base::Universe, base::VariableExpression, base::VDirectory, base::WaypointPathRep, base::WaypointTrajectoryRep, base::World, gfx::IndexedPoint3Array, gfx::OSGWorld, gfx::TriangleIterator, gfx::VisualPath, gfx::VisualTriangles, gfx::VisualTriangles::TriangleArrayIteratorState, physics::Body, physics::Box, physics::Capsule, physics::CollidableGroup, physics::CollisionModel::ModelState, physics::CollisionState, physics::Cone, physics::Cylinder, physics::DynamicSpatial, physics::GJKCollisionDetector, physics::GJKCollisionDetector::GJKCollisionState, physics::GJKCollisionModel, physics::HeightField, physics::LODTerrain, physics::MassProperties, physics::Material, physics::NullCollisionResponseHandler, physics::OBBCollisionDetector, physics::OBBCollisionDetector::OBBCollisionState, physics::OBBCollisionModel, physics::ODEBallJoint, physics::ODECollidableBody, physics::ODECollidableBody::BodyState, physics::ODECollidableGroup, physics::ODECollisionCuller, physics::ODECollisionDetector, physics::ODECollisionDetector::ODECollisionState, physics::ODECollisionModel, physics::ODECollisionResponseHandler, physics::ODEConstraintGroup, physics::ODEContactConstraint, physics::ODEDoubleHingeJoint, physics::ODEFixedConstraint, physics::ODEHingeJoint, physics::ODEMotor, physics::ODESliderJoint, physics::ODESolid, physics::ODESolidConnectedCollidableBody, physics::ODESolidSystem, physics::ODEUniversalJoint, physics::Polyhedron, physics::Polyhedron::Vertex, physics::Polyhedron::Edge, physics::Polyhedron::Polygon, physics::SimpleCollisionCuller, physics::SimpleTerrain, physics::Solid, physics::SOLIDCollisionDetector, physics::SOLIDCollisionDetector::SOLIDCollisionState, physics::SOLIDCollisionModel, physics::SolidCollisionResponseHandler, physics::SpatialGroup, physics::SpatialTransform, physics::Sphere, physics::Torus, physics::VisualDebugUtil, robot::AggregateControlInterface, robot::control::ControllableAdaptor, robot::control::ControllableAdaptor::AdaptorControlInterface, robot::control::kinematics::AnalyticLagrangianFSBetaOptimizer, robot::control::kinematics::AnalyticLagrangianNullSpaceBetaOptimizer, robot::control::kinematics::BetaFormConstraints::BetaFormConstraint, robot::control::kinematics::BetaFormConstraints, robot::control::kinematics::IKOR, robot::control::kinematics::IKOR::JointLimitBetaConstraint, robot::control::kinematics::IKOR::PushAwayBetaConstraint, robot::control::kinematics::IKOR::RankLossBetaConstraint, robot::control::kinematics::IKORController, robot::control::kinematics::IKORController::EEPositionControlInterface, robot::control::kinematics::IKORController::LinkPositionsControlInterface, robot::control::kinematics::IKORFullSpaceSolver, robot::control::kinematics::LeastNormIKSolver, robot::control::kinematics::MPPseudoInvSolver, robot::control::kinematics::OldIKOR, robot::control::kinematics::ReferenceOpVectorFormObjective, robot::control::kinematics::SVDFullSpaceSolver, robot::control::ManipulatorPIDPositionController, robot::control::ManipulatorPIDPositionController::PositionInterface, robot::JFKengine, robot::KinematicChain::Link, robot::KinematicChain, robot::ManipulatorDescription, robot::ManipulatorJointTrajectory, robot::NumericKinematicEvaluator, robot::PlatformDescription, robot::RobotDescription, robot::sim::BasicEnvironment, robot::sim::BasicEnvironment::Tool, robot::sim::BasicEnvironment::Obstacle, robot::sim::Environment, robot::sim::IKORTest, robot::sim::IKORTest::Test, robot::sim::IKORTester, robot::sim::SimulatedBasicEnvironment, robot::sim::SimulatedKinematicChain::ProximityCollisionResponseHandler, robot::sim::SimulatedManipulatorDescription, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedRobot::ManipulatorControlInterface, robot::sim::SimulatedRobot::ToolControlInterface, robot::sim::SimulatedRobot::PlatformControlInterface, robot::sim::SimulatedRobot::ProximitySensorInterface, robot::sim::SimulatedRobotDescription, robot::sim::SimulatedSerialManipulator, robot::sim::SimulatedTool, robot::sim::TestBasicEnvironment, robot::sim::VisualIKORTest, robot::TestRobot, robot::TestRobot::ManipulatorControlInterface, robot::TestRobot::ToolControlInterface, robot::TestRobot::PlatformControlInterface, robot::TestRobot::ProximitySensorInterface, and robot::ToolDescription.

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 base::Transform physics::PositionableOrientable::getConfiguration (   )  const [inline, virtual, inherited]

Reimplemented in physics::SpatialTransform, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedSerialManipulator, and robot::sim::SimulatedTool. Definition at line 60 of file PositionableOrientable. References physics::Orientable::getOrientation(), and physics::Positionable::getPosition(). Referenced by physics::CollidableBody::getBoundingBox(), physics::DynamicSpatial::getGlobalPointRelPos(), physics::DynamicSpatial::getRelPointPos(), physics::PositionableOrientable::operator=(), and physics::PositionableOrientable::PositionableOrientable().

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 Orient physics::Orientable::getOrientation (   )  const [pure virtual, inherited]

Implemented in physics::DynamicSpatial, physics::ODECollidableBody, physics::ODESolid, physics::ODESolidConnectedCollidableBody, physics::SolidConnectedCollidableBody, physics::SpatialGroup, physics::SpatialTransform, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedSerialManipulator, and robot::sim::SimulatedTool. Referenced by physics::PositionableOrientable::getConfiguration(), and physics::Orientable::operator=().

Real physics::PositionableOrientable::getOrientation2D (   )  const [inherited]

get the 2D angle theta (rot. angle about Z-axis)

virtual Point3 physics::Positionable::getPosition (   )  const [pure virtual, inherited]

Implemented in physics::DynamicSpatial, physics::ODECollidableBody, physics::ODESolid, physics::ODESolidConnectedCollidableBody, physics::SolidConnectedCollidableBody, physics::SpatialGroup, physics::SpatialTransform, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedSerialManipulator, and robot::sim::SimulatedTool. Referenced by physics::PositionableOrientable::getConfiguration(), physics::PositionableOrientable::getPosition2D(), and physics::Positionable::operator=().

virtual base::Point2 physics::PositionableOrientable::getPosition2D (   )  const [inline, virtual, inherited]

get the 2D (x,y) position Definition at line 72 of file PositionableOrientable. References physics::Positionable::getPosition(), base::Point2, base::Point3, base::Vector3::x, and base::Vector3::y.

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

virtual Spatial& physics::Spatial::operator= (  const Spatial &  s  )  [inline, virtual]

Definition at line 45 of file Spatial.

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::PositionableOrientable::setConfiguration (  const base::Transform &  configuration  )  [inline, virtual, inherited]

Reimplemented in physics::SpatialGroup, physics::SpatialTransform, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedSerialManipulator, and robot::sim::SimulatedTool. Definition at line 53 of file PositionableOrientable. References base::Transform::getRotation(), base::Transform::getTranslation(), physics::Orientable::setOrientation(), and physics::Positionable::setPosition(). Referenced by physics::PositionableOrientable::operator=(), physics::PositionableOrientable::PositionableOrientable(), and physics::PositionableOrientable::setPositionOrientation().

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

virtual void physics::Orientable::setOrientation (  const Orient &  orient  )  [pure virtual, inherited]

Implemented in physics::DynamicSpatial, physics::ODECollidableBody, physics::ODESolid, physics::ODESolidConnectedCollidableBody, physics::SolidConnectedCollidableBody, physics::SpatialGroup, physics::SpatialTransform, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedSerialManipulator, and robot::sim::SimulatedTool. Referenced by physics::Orientable::operator=(), and physics::PositionableOrientable::setConfiguration().

virtual void physics::Positionable::setPosition (  const Point3 &  pos  )  [pure virtual, inherited]

Implemented in physics::DynamicSpatial, physics::ODECollidableBody, physics::ODESolid, physics::ODESolidConnectedCollidableBody, physics::SolidConnectedCollidableBody, physics::SpatialGroup, physics::SpatialTransform, robot::sim::SimulatedPlatform, robot::sim::SimulatedRobot, robot::sim::SimulatedSerialManipulator, and robot::sim::SimulatedTool. Referenced by physics::Positionable::operator=(), and physics::PositionableOrientable::setConfiguration().

virtual void physics::PositionableOrientable::setPosition2D (  const base::Point2 &  p, Real  theta )  [virtual, inherited]

set the 2D (x,y,theta) position (theta is rot. angle about Z-axis)

virtual void physics::PositionableOrientable::setPositionOrientation (  const Point3 &  pos, const Orient &  orient )  [inline, virtual, inherited]

Definition at line 48 of file PositionableOrientable. References base::Point3, and physics::PositionableOrientable::setConfiguration().

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

---

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

• physics/Spatial

---