makVrv::DtBaseTextAttribute Class Reference

The attribute layout tells DtAttributes where to draw.

Inheritance diagram for makVrv::DtBaseTextAttribute:

Public Member Functions
virtual	~DtBaseTextAttribute ()
	DtBaseTextAttribute ()=delete
	DtBaseTextAttribute (const DtBaseTextAttribute &other)=delete
DtBaseTextAttribute &	operator= (const DtBaseTextAttribute &other)=delete
virtual void	setString (const DtUnicode &str)
virtual void	setPosition (float x, float y, float z, float w)
virtual void	getMinSize (double &xOut, double &yOut)
virtual void	setOffset (double x, double y)
virtual void	setVisible (bool isVisible)
virtual void	setLodOutAltitude (double lodOutAltitude)
virtual double	lodOutAltitude () const
virtual void	setIsLodOutAltitudeEnabled (bool isEnabled)
virtual bool	isLodOutAltitudeEnabled () const
virtual void	setColor (float r, float g, float b, float a)
virtual void	setFont (const std::string &fontFile, float sizeInPoints)
virtual bool	visible () const
virtual void	setSize (double x, double y)
virtual void	setOverlay (unsigned int overlayId)
virtual void	setGroup (unsigned int group)
virtual void	setForegroundGroup (unsigned int group)
virtual void	setBackgroundGroup (unsigned int group)
virtual float	fontSize ()
virtual const std::string &	fontFile ()
virtual void	setShadowText (bool enabled)
Public Member Functions inherited from makVrv::DtAttribute
	DtAttribute ()
virtual	~DtAttribute ()
	DtAttribute (const DtAttribute &other)=delete
DtAttribute &	operator= (const DtAttribute &other)=delete

Static Public Member Functions
static float	pointsToPixelsAprox (float points)

Protected Member Functions
	DtBaseTextAttribute (DtDe &de)
virtual void	setStringForText (const DtUnicode &str, DtTextProxy &text)
virtual void	setFontForText (const std::string &fontFile, float sizeInPoints, DtTextProxy &text)
virtual void	setOffsetForText (double x, double y, DtTextProxy &text)
virtual void	setVisibleForText (DtTextProxy &text)
virtual void	createText ()

Protected Attributes
DtDe &	myDe
float	myColorR
float	myColorG
float	myColorB
float	myColorA
std::string	myFontFile
double	myLodOutAltitude
bool	myIsLodOutAltitudeEnabled
float	myFontSize
float	myWidth
float	myOffsetX
float	myOffsetY
float	myWorldX
float	myWorldY
float	myWorldZ
float	myWorldW
double	mySizeX
double	mySizeY
DtFont::TextAlignement	myAlignment
DtTextProxy *	myText
DtTextProxy *	myShadowText
DtUnicode	myString
unsigned int	myOverlayId
unsigned int	myForegroundOverlayGroup
unsigned int	myBackgroundOverlayGroup
bool	myShadowTextFlag

Private Attributes
friend	DtBaseTextAttributeCreator

Additional Inherited Members
Public Attributes inherited from makVrv::DtAttribute
boost::signalslib::signal < void(DtAttribute *, double, double)>	signal_sizeChanged

Constructor & Destructor Documentation

virtual makVrv::DtBaseTextAttribute::~DtBaseTextAttribute ( )

virtual

DTOR.

makVrv::DtBaseTextAttribute::DtBaseTextAttribute ( )

delete

Default Constructor not implemented.

makVrv::DtBaseTextAttribute::DtBaseTextAttribute ( const DtBaseTextAttribute &  other )

delete

Copy Constructor not implemented - Copy not allowed.

makVrv::DtBaseTextAttribute::DtBaseTextAttribute ( DtDe &  de )

protected

Protected CTOR Use DtBaseTextAttributeCreator to create an instance of this class.

Member Function Documentation

DtBaseTextAttribute& makVrv::DtBaseTextAttribute::operator= ( const DtBaseTextAttribute &  other )

delete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtBaseTextAttribute::setString ( const DtUnicode &  str )

virtual

Set the string to render.

virtual void makVrv::DtBaseTextAttribute::setPosition ( float  x, float  y, float  z, float  w  )

virtual

Set the position of the attribute in world space, using vrvGraphics float packing.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::getMinSize ( double &  xOut, double &  yOut  )

virtual

Get the size of the attribute.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setOffset ( double  x, double  y  )

virtual

Set the Top left corner of the text.

Reimplemented from makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setVisible ( bool  isVisible )

virtual

Set the text visible or invisible.

Implements makVrv::DtAttribute.

Reimplemented in makVrv::DtNumericAttribute, and makVrv::DtTextAttribute.

virtual void makVrv::DtBaseTextAttribute::setLodOutAltitude ( double  lodOutAltitude )

virtual

Set the altitude, in meters, at which this attribute no longer appears.

Implements makVrv::DtAttribute.

virtual double makVrv::DtBaseTextAttribute::lodOutAltitude ( ) const

virtual

Get the altitude, in meters, at which this attribute no longer appears.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setIsLodOutAltitudeEnabled ( bool  isEnabled )

virtual

Set whether or not this attribute will use the LOD Out Altitude property.

Implements makVrv::DtAttribute.

virtual bool makVrv::DtBaseTextAttribute::isLodOutAltitudeEnabled ( ) const

virtual

Get whether or not this attribute will use the LOD Out Altitude property.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setColor ( float  r, float  g, float  b, float  a  )

virtual

Set the text's color.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setFont ( const std::string &  fontFile, float  sizeInPoints  )

virtual

Set the font file and size in points to display the text in.

virtual bool makVrv::DtBaseTextAttribute::visible ( ) const

virtual

Get the text's visibility status.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setSize ( double  x, double  y  )

virtual

Set the size of the text box.

Implements makVrv::DtAttribute.

static float makVrv::DtBaseTextAttribute::pointsToPixelsAprox ( float  points )

static

Convert a dimension in points to an approximatation of pixels (The exact correct value depends on monitor DPI)

virtual void makVrv::DtBaseTextAttribute::setOverlay ( unsigned int  overlayId )

virtual

Set the overlay to draw the attribute on Overlay ids are defined in DtOverlayManager.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setGroup ( unsigned int  group )

virtual

Set the group to draw the atribute on. This sets the text's foreground and background to use the same (given group ID). Using separate IDs for the text and shadow (via the setForegroundGroup(..) and setBackgroundGroup(..) methods) is recommended in order to avoid cases where the shadow text appears on top of the text itself.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setForegroundGroup ( unsigned int  group )

virtual

Set the group to draw the text's foreground on.

Reimplemented from makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setBackgroundGroup ( unsigned int  group )

virtual

Set the group to draw the text's background (shadow) on.

Reimplemented from makVrv::DtAttribute.

virtual float makVrv::DtBaseTextAttribute::fontSize ( )

virtual

Get the text's font size in points.

virtual const std::string& makVrv::DtBaseTextAttribute::fontFile ( )

virtual

Get the text's font file name.

virtual void makVrv::DtBaseTextAttribute::setShadowText ( bool  enabled )

virtual

Set whether text shadows should be displayed.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseTextAttribute::setStringForText ( const DtUnicode &  str, DtTextProxy &  text  )

protectedvirtual

setString for a specific text proxy

virtual void makVrv::DtBaseTextAttribute::setFontForText ( const std::string &  fontFile, float  sizeInPoints, DtTextProxy &  text  )

protectedvirtual

setFont for a specific text proxy

virtual void makVrv::DtBaseTextAttribute::setOffsetForText ( double  x, double  y, DtTextProxy &  text  )

protectedvirtual

setOffset for a specific text proxy

virtual void makVrv::DtBaseTextAttribute::setVisibleForText ( DtTextProxy &  text )

protectedvirtual

set a specific text object visible

virtual void makVrv::DtBaseTextAttribute::createText ( )

protectedvirtual

Create the text object.

Member Data Documentation

friend makVrv::DtBaseTextAttribute::DtBaseTextAttributeCreator

private

DtDe& makVrv::DtBaseTextAttribute::myDe

protected

float makVrv::DtBaseTextAttribute::myColorR

protected

float makVrv::DtBaseTextAttribute::myColorG

protected

float makVrv::DtBaseTextAttribute::myColorB

protected

float makVrv::DtBaseTextAttribute::myColorA

protected

std::string makVrv::DtBaseTextAttribute::myFontFile

protected

double makVrv::DtBaseTextAttribute::myLodOutAltitude

protected

bool makVrv::DtBaseTextAttribute::myIsLodOutAltitudeEnabled

protected

float makVrv::DtBaseTextAttribute::myFontSize

protected

float makVrv::DtBaseTextAttribute::myWidth

protected

float makVrv::DtBaseTextAttribute::myOffsetX

protected

float makVrv::DtBaseTextAttribute::myOffsetY

protected

float makVrv::DtBaseTextAttribute::myWorldX

protected

float makVrv::DtBaseTextAttribute::myWorldY

protected

float makVrv::DtBaseTextAttribute::myWorldZ

protected

float makVrv::DtBaseTextAttribute::myWorldW

protected

double makVrv::DtBaseTextAttribute::mySizeX

protected

double makVrv::DtBaseTextAttribute::mySizeY

protected

DtFont::TextAlignement makVrv::DtBaseTextAttribute::myAlignment

protected

DtTextProxy* makVrv::DtBaseTextAttribute::myText

protected

DtTextProxy* makVrv::DtBaseTextAttribute::myShadowText

protected

DtUnicode makVrv::DtBaseTextAttribute::myString

protected

unsigned int makVrv::DtBaseTextAttribute::myOverlayId

protected

unsigned int makVrv::DtBaseTextAttribute::myForegroundOverlayGroup

protected

unsigned int makVrv::DtBaseTextAttribute::myBackgroundOverlayGroup

protected

bool makVrv::DtBaseTextAttribute::myShadowTextFlag

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvOsg/DtBaseTextAttribute.h