Rigs of Rods 2023.09
Soft-body Physics Simulation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
RoR::MovableText Class Reference
Gfx

#include <MovableText.h>

+ Inheritance diagram for RoR::MovableText:

Public Types

enum  HorizontalAlignment { H_LEFT , H_CENTER }
 
enum  VerticalAlignment { V_BELOW , V_ABOVE }
 

Public Member Functions

 MovableText (const std::string &name, const std::string &caption, const std::string &fontName="highcontrast_black", Ogre::Real charHeight=1.0, const Ogre::ColourValue &color=Ogre::ColourValue::Black)
 
virtual ~MovableText ()
 
virtual void visitRenderables (Ogre::Renderable::Visitor *, bool) override
 
void setFontName (const std::string &fontName)
 
void setCaption (const std::string &caption)
 
void setColor (const Ogre::ColourValue &color)
 
void setCharacterHeight (Ogre::Real height)
 
void setSpaceWidth (Ogre::Real width)
 
void setTextAlignment (const HorizontalAlignment &horizontalAlignment, const VerticalAlignment &verticalAlignment)
 
void setAdditionalHeight (Ogre::Real height)
 
void showOnTop (bool show=true)
 
const std::string & getFontName () const
 
const std::string & getCaption () const
 
const Ogre::ColourValue & getColor () const
 
Ogre::uint getCharacterHeight () const
 
Ogre::uint getSpaceWidth () const
 
Ogre::Real getAdditionalHeight () const
 
bool getShowOnTop () const
 
Ogre::AxisAlignedBox GetAABB (void)
 

Protected Member Functions

void _setupGeometry ()
 
void _updateColors ()
 
void getWorldTransforms (Ogre::Matrix4 *xform) const
 
Ogre::Real getBoundingRadius (void) const
 
Ogre::Real getSquaredViewDepth (const Ogre::Camera *) const
 
const Ogre::Quaternion & getWorldOrientation (void) const
 
const Ogre::Vector3 & getWorldPosition (void) const
 
const Ogre::AxisAlignedBox & getBoundingBox (void) const
 
const Ogre::String & getName (void) const
 
const Ogre::String & getMovableType (void) const
 
void _notifyCurrentCamera (Ogre::Camera *cam)
 
void _updateRenderQueue (Ogre::RenderQueue *queue)
 
void getRenderOperation (Ogre::RenderOperation &op)
 
const Ogre::MaterialPtr & getMaterial (void) const
 
const Ogre::LightList & getLights (void) const
 

Protected Attributes

std::string mFontName
 
std::string mType
 
Ogre::String mName
 
std::string mCaption
 
HorizontalAlignment mHorizontalAlignment
 
VerticalAlignment mVerticalAlignment
 
Ogre::ColourValue mColor
 
Ogre::RenderOperation mRenderOp
 
Ogre::AxisAlignedBox mAABB
 
Ogre::LightList mLList
 
Ogre::Real mCharHeight
 
Ogre::Real mSpaceWidth
 
bool mNeedUpdate
 
bool mUpdateColors
 
bool mOnTop
 
Ogre::Real mTimeUntilNextToggle
 
Ogre::Real mRadius
 
Ogre::Real mAdditionalHeight
 
Ogre::Camera * mpCam
 
Ogre::RenderWindow * mpWin
 
Ogre::Font * mpFont
 
Ogre::MaterialPtr mpMaterial
 
Ogre::MaterialPtr mpBackgroundMaterial
 

Detailed Description

Definition at line 38 of file MovableText.h.

Member Enumeration Documentation

◆ HorizontalAlignment

enum RoR::MovableText::HorizontalAlignment
Enumerator
H_LEFT 
H_CENTER 

Definition at line 42 of file MovableText.h.

◆ VerticalAlignment

enum RoR::MovableText::VerticalAlignment
Enumerator
V_BELOW 
V_ABOVE 

Definition at line 43 of file MovableText.h.

Constructor & Destructor Documentation

◆ MovableText()

MovableText::MovableText ( const std::string &  name,
const std::string &  caption,
const std::string &  fontName = "highcontrast_black",
Ogre::Real  charHeight = 1.0,
const Ogre::ColourValue &  color = Ogre::ColourValue::Black 
)

Definition at line 37 of file MovableText.cpp.

◆ ~MovableText()

MovableText::~MovableText ( )
virtual

Definition at line 67 of file MovableText.cpp.

Member Function Documentation

◆ _notifyCurrentCamera()

void MovableText::_notifyCurrentCamera ( Ogre::Camera *  cam)
protected

Definition at line 536 of file MovableText.cpp.

◆ _setupGeometry()

void MovableText::_setupGeometry ( )
protected

Definition at line 178 of file MovableText.cpp.

◆ _updateColors()

void MovableText::_updateColors ( void  )
protected

Definition at line 462 of file MovableText.cpp.

◆ _updateRenderQueue()

void MovableText::_updateRenderQueue ( Ogre::RenderQueue *  queue)
protected

Definition at line 541 of file MovableText.cpp.

◆ GetAABB()

Ogre::AxisAlignedBox RoR::MovableText::GetAABB ( void  )
inline

Definition at line 104 of file MovableText.h.

◆ getAdditionalHeight()

Ogre::Real RoR::MovableText::getAdditionalHeight ( ) const
inline

Definition at line 102 of file MovableText.h.

◆ getBoundingBox()

const Ogre::AxisAlignedBox & RoR::MovableText::getBoundingBox ( void  ) const
inlineprotected

Definition at line 119 of file MovableText.h.

◆ getBoundingRadius()

Ogre::Real RoR::MovableText::getBoundingRadius ( void  ) const
inlineprotected

Definition at line 115 of file MovableText.h.

◆ getCaption()

const std::string & RoR::MovableText::getCaption ( ) const
inline

Definition at line 97 of file MovableText.h.

◆ getCharacterHeight()

Ogre::uint RoR::MovableText::getCharacterHeight ( ) const
inline

Definition at line 100 of file MovableText.h.

◆ getColor()

const Ogre::ColourValue & RoR::MovableText::getColor ( ) const
inline

Definition at line 98 of file MovableText.h.

◆ getFontName()

const std::string & RoR::MovableText::getFontName ( ) const
inline

Definition at line 96 of file MovableText.h.

◆ getLights()

const Ogre::LightList & RoR::MovableText::getLights ( void  ) const
inlineprotected

Definition at line 129 of file MovableText.h.

◆ getMaterial()

const Ogre::MaterialPtr & RoR::MovableText::getMaterial ( void  ) const
inlineprotected

Definition at line 128 of file MovableText.h.

◆ getMovableType()

const Ogre::String & RoR::MovableText::getMovableType ( void  ) const
inlineprotected

Definition at line 121 of file MovableText.h.

◆ getName()

const Ogre::String & RoR::MovableText::getName ( void  ) const
inlineprotected

Definition at line 120 of file MovableText.h.

◆ getRenderOperation()

void MovableText::getRenderOperation ( Ogre::RenderOperation &  op)
protected

Definition at line 524 of file MovableText.cpp.

◆ getShowOnTop()

bool RoR::MovableText::getShowOnTop ( ) const
inline

Definition at line 103 of file MovableText.h.

◆ getSpaceWidth()

Ogre::uint RoR::MovableText::getSpaceWidth ( ) const
inline

Definition at line 101 of file MovableText.h.

◆ getSquaredViewDepth()

Ogre::Real RoR::MovableText::getSquaredViewDepth ( const Ogre::Camera *  ) const
inlineprotected

Definition at line 116 of file MovableText.h.

◆ getWorldOrientation()

const Quaternion & MovableText::getWorldOrientation ( void  ) const
protected

Definition at line 489 of file MovableText.cpp.

◆ getWorldPosition()

const Vector3 & MovableText::getWorldPosition ( void  ) const
protected

Definition at line 495 of file MovableText.cpp.

◆ getWorldTransforms()

void MovableText::getWorldTransforms ( Ogre::Matrix4 *  xform) const
protected

Definition at line 501 of file MovableText.cpp.

◆ setAdditionalHeight()

void MovableText::setAdditionalHeight ( Ogre::Real  height)

Definition at line 158 of file MovableText.cpp.

◆ setCaption()

void MovableText::setCaption ( const std::string &  caption)

Definition at line 108 of file MovableText.cpp.

◆ setCharacterHeight()

void MovableText::setCharacterHeight ( Ogre::Real  height)

Definition at line 126 of file MovableText.cpp.

◆ setColor()

void MovableText::setColor ( const Ogre::ColourValue &  color)

Definition at line 117 of file MovableText.cpp.

◆ setFontName()

void MovableText::setFontName ( const std::string &  fontName)

Definition at line 73 of file MovableText.cpp.

◆ setSpaceWidth()

void MovableText::setSpaceWidth ( Ogre::Real  width)

Definition at line 135 of file MovableText.cpp.

◆ setTextAlignment()

void MovableText::setTextAlignment ( const HorizontalAlignment &  horizontalAlignment,
const VerticalAlignment &  verticalAlignment 
)

Definition at line 144 of file MovableText.cpp.

◆ showOnTop()

void MovableText::showOnTop ( bool  show = true)

Definition at line 167 of file MovableText.cpp.

◆ visitRenderables()

virtual void RoR::MovableText::visitRenderables ( Ogre::Renderable::Visitor *  ,
bool   
)
inlineoverridevirtual

Definition at line 83 of file MovableText.h.

Field Documentation

◆ mAABB

Ogre::AxisAlignedBox RoR::MovableText::mAABB
protected

Definition at line 55 of file MovableText.h.

◆ mAdditionalHeight

Ogre::Real RoR::MovableText::mAdditionalHeight
protected

Definition at line 67 of file MovableText.h.

◆ mCaption

std::string RoR::MovableText::mCaption
protected

Definition at line 49 of file MovableText.h.

◆ mCharHeight

Ogre::Real RoR::MovableText::mCharHeight
protected

Definition at line 58 of file MovableText.h.

◆ mColor

Ogre::ColourValue RoR::MovableText::mColor
protected

Definition at line 53 of file MovableText.h.

◆ mFontName

std::string RoR::MovableText::mFontName
protected

Definition at line 46 of file MovableText.h.

◆ mHorizontalAlignment

HorizontalAlignment RoR::MovableText::mHorizontalAlignment
protected

Definition at line 50 of file MovableText.h.

◆ mLList

Ogre::LightList RoR::MovableText::mLList
protected

Definition at line 56 of file MovableText.h.

◆ mName

Ogre::String RoR::MovableText::mName
protected

Definition at line 48 of file MovableText.h.

◆ mNeedUpdate

bool RoR::MovableText::mNeedUpdate
protected

Definition at line 61 of file MovableText.h.

◆ mOnTop

bool RoR::MovableText::mOnTop
protected

Definition at line 63 of file MovableText.h.

◆ mpBackgroundMaterial

Ogre::MaterialPtr RoR::MovableText::mpBackgroundMaterial
protected

Definition at line 73 of file MovableText.h.

◆ mpCam

Ogre::Camera* RoR::MovableText::mpCam
protected

Definition at line 69 of file MovableText.h.

◆ mpFont

Ogre::Font* RoR::MovableText::mpFont
protected

Definition at line 71 of file MovableText.h.

◆ mpMaterial

Ogre::MaterialPtr RoR::MovableText::mpMaterial
protected

Definition at line 72 of file MovableText.h.

◆ mpWin

Ogre::RenderWindow* RoR::MovableText::mpWin
protected

Definition at line 70 of file MovableText.h.

◆ mRadius

Ogre::Real RoR::MovableText::mRadius
protected

Definition at line 66 of file MovableText.h.

◆ mRenderOp

Ogre::RenderOperation RoR::MovableText::mRenderOp
protected

Definition at line 54 of file MovableText.h.

◆ mSpaceWidth

Ogre::Real RoR::MovableText::mSpaceWidth
protected

Definition at line 59 of file MovableText.h.

◆ mTimeUntilNextToggle

Ogre::Real RoR::MovableText::mTimeUntilNextToggle
protected

Definition at line 65 of file MovableText.h.

◆ mType

std::string RoR::MovableText::mType
protected

Definition at line 47 of file MovableText.h.

◆ mUpdateColors

bool RoR::MovableText::mUpdateColors
protected

Definition at line 62 of file MovableText.h.

◆ mVerticalAlignment

VerticalAlignment RoR::MovableText::mVerticalAlignment
protected

Definition at line 51 of file MovableText.h.

The documentation for this class was generated from the following files:
Generated on Fri Jan 2 2026 09:37:04 for Rigs of Rods by doxygen 1.9.8