The subclass of PhyObject2DWrapper wrapping a cylinder. More...

Inheritance diagram for Cylinder2DWrapper:

Public Member Functions

virtual bool computeDistanceAndOrientationFromRobot (const WheeledRobot2DWrapper &robot, double &distance, double &angle) const
 Computes the distance and orientation of this object respect to the given robot.
 
virtual void computeLinearViewFieldOccupiedRange (const wMatrix &cameraMtr, double &minAngle, double &maxAngle, double &distance) const
 Computes the portion of a linear the view field occupied by this object.
 
virtual PhyCylinderphyObject ()
 Returns a pointer to the wrapped PhyObject.
 
virtual const PhyCylinderphyObject () const
 Returns a pointer to the wrapped PhyObject (const version)
 
virtual void setPosition (real x, real y)
 Sets the position of the object in the plane.
 
virtual void setStatic (bool s)
 Sets whether the object is static or not.
 
virtual Type type () const
 Returns the type of this wrapper object.
 
- Public Member Functions inherited from PhyObject2DWrapper
QColor color () const
 Returns the color to use when rendering this.
 
bool getStatic () const
 Returns true if the object is static.
 
wVector position () const
 Returns the position of the object.
 
void setColor (QColor color)
 Sets the color to use when rendering this.
 
void setPosition (wVector pos)
 Sets the position of the object in the plane.
 
void setTexture (QString textureName)
 Set the texture to use when rendering this.
 
void setUseColorTextureOfOwner (bool b)
 Sets whether this will be rendered with the color and texture of our owner (if we have one)
 
QString texture () const
 Returns the name of the texture.
 
bool useColorTextureOfOwner () const
 Returns whether this will be rendered with the color and texture of the owner (if we have one)
 
virtual WObjectwObject ()
 Returns a pointer to the wrapped object.
 
virtual const WObjectwObject () const
 Returns a pointer to the wrapped object (const version)
 

Protected Member Functions

 Cylinder2DWrapper (Arena *arena, PhyCylinder *cylinder, Type type)
 Constructor.
 
 ~Cylinder2DWrapper ()
 Destructor.
 
- Protected Member Functions inherited from PhyObject2DWrapper
 PhyObject2DWrapper (Arena *arena)
 Constructor.
 
virtual ~PhyObject2DWrapper ()
 Destructor.
 

Friends

class Arena
 The Arena class is friend to be able to instantiate and delete this class.
 

Additional Inherited Members

- Public Types inherited from PhyObject2DWrapper
enum  Type {
  Plane = 0, Wall, Box, RectangularTargetArea,
  Cylinder, SmallCylinder, BigCylinder, CircularTargetArea,
  WheeledRobot, NumberOfDifferentTypes
}
 The possible type of wrapped objects. More...
 
- Protected Attributes inherited from PhyObject2DWrapper
Arena *const m_arena
 The pointer to the arena in which this object lives.
 

Detailed Description

The subclass of PhyObject2DWrapper wrapping a cylinder.

Definition at line 455 of file wheeledexperimenthelper.h.

Constructor & Destructor Documentation

Cylinder2DWrapper ( Arena arena,
PhyCylinder cylinder,
Type  type 
)
protected

Constructor.

Parameters
arenathe arena in which this object lives
cylinderthe cylinder to wrap
typethe type of cylinder. This can only be one of Cylinder, SmallCylinder, BigCylinder or CircularTargetArea. If the type is CircularTargetArea, this cannot be made non-static

Definition at line 488 of file wheeledexperimenthelper.cpp.

References PhyCylinder::setStatic().

~Cylinder2DWrapper ( )
protected

Destructor.

Definition at line 498 of file wheeledexperimenthelper.cpp.

Member Function Documentation

bool computeDistanceAndOrientationFromRobot ( const WheeledRobot2DWrapper robot,
double &  distance,
double &  angle 
) const
virtual

Computes the distance and orientation of this object respect to the given robot.

This function computes the distance of this object from the given robot. The distance is computed between the nearest points of the two objects. The robot is always modelled as a vertical cylindrical object. The function returns false if it makes no sense to compute the distance

Parameters
robotthe robot from which the distance should be computed
distancethe computed distance
anglethe computed orientation
Returns
false if the distance couldn't be computed

Implements PhyObject2DWrapper.

Definition at line 550 of file wheeledexperimenthelper.cpp.

References Arena::getPlane(), WheeledRobot2DWrapper::getRadius(), PhyObject2DWrapper::m_arena, PhyCylinder::matrix(), PhyObject2DWrapper::position(), PhyCylinder::radius(), wMatrix::w_pos, and WheeledRobot2DWrapper::wObject().

void computeLinearViewFieldOccupiedRange ( const wMatrix cameraMtr,
double &  minAngle,
double &  maxAngle,
double &  distance 
) const
virtual

Computes the portion of a linear the view field occupied by this object.

This function returns the angular range occupied by this object on a linear camera described by the given matrix. The Z axis of the matrix is the upvector, the camera lies on the XY plane and points towars the X axis (i.e. angles start from the X axis). If the object is not visible by the camera, this function returns a negative distance. The min angle can be greater than the max angle if the object is behind the camera. Here we make the assumption that the camera is outside the object (otherwise the algorithm gives wrong results). The matrix representing the camera is translated so that it is on the same plane as the lower base of the object before doing computations

Parameters
cameraMtrthe matrix describing the camera (see function description)
minAnglethis is set to the minimum angle of the view field occupied by the object
maxAnglethis is set to the maximum angle of the view field occupied by the object
distancethis is set to the distance of the object from the camera. It is negative if the object is not visible by the camera

Implements PhyObject2DWrapper.

Definition at line 538 of file wheeledexperimenthelper.cpp.

References PhyCylinder::height(), PhyCylinder::matrix(), and PhyCylinder::radius().

PhyCylinder * phyObject ( )
virtual

Returns a pointer to the wrapped PhyObject.

You should avoid changing the PhyObject directly, use the methods of this class, instead

Returns
a pointer to the wrapped PhyObject

Implements PhyObject2DWrapper.

Definition at line 503 of file wheeledexperimenthelper.cpp.

Referenced by Arena::createCircularTargetArea(), Cylinder2DWrapper::setPosition(), and Cylinder2DWrapper::setStatic().

const PhyCylinder * phyObject ( ) const
virtual

Returns a pointer to the wrapped PhyObject (const version)

Returns
a const pointer to the wrapped PhyObject

Implements PhyObject2DWrapper.

Definition at line 508 of file wheeledexperimenthelper.cpp.

void setPosition ( real  x,
real  y 
)
virtual

Sets the position of the object in the plane.

Parameters
xthe new x coordinate
ythe new y coordinate

Implements PhyObject2DWrapper.

Definition at line 528 of file wheeledexperimenthelper.cpp.

References PhyCylinder::matrix(), Cylinder2DWrapper::phyObject(), PhyCylinder::setPosition(), wMatrix::w_pos, and wVectorT< Shared >::x.

void setStatic ( bool  s)
virtual

Sets whether the object is static or not.

Whether this can be made static or not depends on the type of cylinder

Parameters
sif true the object will be static

Reimplemented from PhyObject2DWrapper.

Definition at line 513 of file wheeledexperimenthelper.cpp.

References Cylinder2DWrapper::phyObject(), and PhyCylinder::setStatic().

Cylinder2DWrapper::Type type ( ) const
virtual

Returns the type of this wrapper object.

Returns
the type of this wrapper object

Implements PhyObject2DWrapper.

Definition at line 523 of file wheeledexperimenthelper.cpp.

Friends And Related Function Documentation

friend class Arena
friend

The Arena class is friend to be able to instantiate and delete this class.

Definition at line 577 of file wheeledexperimenthelper.h.


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