Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rviz::MarkerBase Class Referenceabstract

#include <marker_base.h>

Inheritance diagram for rviz::MarkerBase:
Inheritance graph
[legend]

Public Types

typedef visualization_msgs::Marker Marker
 
typedef visualization_msgs::Marker::ConstPtr MarkerConstPtr
 

Public Member Functions

bool expired ()
 
MarkerID getID ()
 
virtual S_MaterialPtr getMaterials ()
 
const MarkerConstPtrgetMessage () const
 
const Ogre::Quaternion & getOrientation () const
 
const Ogre::Vector3 & getPosition () const
 
std::string getStringID ()
 
 MarkerBase (MarkerDisplay *owner, DisplayContext *context, Ogre::SceneNode *parent_node)
 
void setInteractiveObject (InteractiveObjectWPtr object)
 Associate an InteractiveObject with this MarkerBase. More...
 
void setMessage (const Marker &message)
 
void setMessage (const MarkerConstPtr &message)
 
virtual void setOrientation (const Ogre::Quaternion &orientation)
 
virtual void setPosition (const Ogre::Vector3 &position)
 
void updateFrameLocked ()
 
virtual ~MarkerBase ()
 

Protected Member Functions

void extractMaterials (Ogre::Entity *entity, S_MaterialPtr &materials)
 
virtual void onNewMessage (const MarkerConstPtr &old_message, const MarkerConstPtr &new_message)=0
 
bool transform (const MarkerConstPtr &message, Ogre::Vector3 &pos, Ogre::Quaternion &orient, Ogre::Vector3 &scale)
 

Protected Attributes

DisplayContextcontext_
 
ros::Time expiration_
 
boost::shared_ptr< MarkerSelectionHandlerhandler_
 
MarkerConstPtr message_
 
MarkerDisplayowner_
 
Ogre::SceneNode * scene_node_
 

Detailed Description

Definition at line 53 of file marker_base.h.

Member Typedef Documentation

◆ Marker

typedef visualization_msgs::Marker rviz::MarkerBase::Marker

Definition at line 56 of file marker_base.h.

◆ MarkerConstPtr

typedef visualization_msgs::Marker::ConstPtr rviz::MarkerBase::MarkerConstPtr

Definition at line 57 of file marker_base.h.

Constructor & Destructor Documentation

◆ MarkerBase()

rviz::MarkerBase::MarkerBase ( MarkerDisplay owner,
DisplayContext context,
Ogre::SceneNode *  parent_node 
)

Definition at line 49 of file marker_base.cpp.

◆ ~MarkerBase()

rviz::MarkerBase::~MarkerBase ( )
virtual

Definition at line 54 of file marker_base.cpp.

Member Function Documentation

◆ expired()

bool rviz::MarkerBase::expired ( )

Definition at line 82 of file marker_base.cpp.

◆ extractMaterials()

void rviz::MarkerBase::extractMaterials ( Ogre::Entity *  entity,
S_MaterialPtr materials 
)
protected

Definition at line 144 of file marker_base.cpp.

◆ getID()

MarkerID rviz::MarkerBase::getID ( )
inline

Definition at line 74 of file marker_base.h.

◆ getMaterials()

virtual S_MaterialPtr rviz::MarkerBase::getMaterials ( )
inlinevirtual

◆ getMessage()

const MarkerConstPtr& rviz::MarkerBase::getMessage ( ) const
inline

Definition at line 69 of file marker_base.h.

◆ getOrientation()

const Ogre::Quaternion & rviz::MarkerBase::getOrientation ( ) const

Definition at line 139 of file marker_base.cpp.

◆ getPosition()

const Ogre::Vector3 & rviz::MarkerBase::getPosition ( ) const

Definition at line 134 of file marker_base.cpp.

◆ getStringID()

std::string rviz::MarkerBase::getStringID ( )
inline

Definition at line 78 of file marker_base.h.

◆ onNewMessage()

virtual void rviz::MarkerBase::onNewMessage ( const MarkerConstPtr old_message,
const MarkerConstPtr new_message 
)
protectedpure virtual

◆ setInteractiveObject()

void rviz::MarkerBase::setInteractiveObject ( InteractiveObjectWPtr  object)

Associate an InteractiveObject with this MarkerBase.

Definition at line 116 of file marker_base.cpp.

◆ setMessage() [1/2]

void rviz::MarkerBase::setMessage ( const Marker message)

Definition at line 59 of file marker_base.cpp.

◆ setMessage() [2/2]

void rviz::MarkerBase::setMessage ( const MarkerConstPtr message)

Definition at line 66 of file marker_base.cpp.

◆ setOrientation()

void rviz::MarkerBase::setOrientation ( const Ogre::Quaternion &  orientation)
virtual

Reimplemented in rviz::TextViewFacingMarker.

Definition at line 129 of file marker_base.cpp.

◆ setPosition()

void rviz::MarkerBase::setPosition ( const Ogre::Vector3 &  position)
virtual

Definition at line 124 of file marker_base.cpp.

◆ transform()

bool rviz::MarkerBase::transform ( const MarkerConstPtr message,
Ogre::Vector3 &  pos,
Ogre::Quaternion &  orient,
Ogre::Vector3 &  scale 
)
protected

Definition at line 87 of file marker_base.cpp.

◆ updateFrameLocked()

void rviz::MarkerBase::updateFrameLocked ( )

Definition at line 76 of file marker_base.cpp.

Member Data Documentation

◆ context_

DisplayContext* rviz::MarkerBase::context_
protected

Definition at line 108 of file marker_base.h.

◆ expiration_

ros::Time rviz::MarkerBase::expiration_
protected

Definition at line 114 of file marker_base.h.

◆ handler_

boost::shared_ptr<MarkerSelectionHandler> rviz::MarkerBase::handler_
protected

Definition at line 116 of file marker_base.h.

◆ message_

MarkerConstPtr rviz::MarkerBase::message_
protected

Definition at line 112 of file marker_base.h.

◆ owner_

MarkerDisplay* rviz::MarkerBase::owner_
protected

Definition at line 107 of file marker_base.h.

◆ scene_node_

Ogre::SceneNode* rviz::MarkerBase::scene_node_
protected

Definition at line 110 of file marker_base.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:11