SurgSim::Graphics::OsgFont Class Reference

Osg specialization of the Font class, supports osgText::Font. More...

`#include <SurgSim/Graphics/OsgFont.h>`

Inheritance diagram for SurgSim::Graphics::OsgFont:

## Public Member Functions

| OsgFont ()
| Constructor. More...
virtual | ~OsgFont ()
| Destructor. More...
| SURGSIM_CLASSNAME (SurgSim::Graphics::OsgFont)
osg::ref_ptr< osgText::Font > | getOsgFont () const
Public Member Functions inherited from SurgSim::Framework::Asset
| Asset ()
| Constructor. More...
| Asset (const Asset &rhs)
| Copy Constructor. More...
virtual | ~Asset ()
| Destructor. More...
void | load (const std::string &fileName, const SurgSim::Framework::ApplicationData &data)
| Load a file with given name using 'data' as look up path(s). More...
void | load (const std::string &fileName)
| Overloaded function using SurgSim::Framework::Runtime::getApplicationData() as look up path(s). More...
std::string | getFileName () const
| Return the name of file loaded by this class. More...
virtual std::string | getClassName () const =0
| Support serialization with a classname. More...
Public Member Functions inherited from SurgSim::Framework::Accessible
| Accessible ()
| Default Constructor. More...
| ~Accessible ()
| Destructor. More...
template<class T >
T | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
boost::any | getValue (const std::string &name) const
| Retrieves the value with the name by executing the getter if it is found. More...
template<class T >
bool | getValue (const std::string &name, T *value) const
| Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
void | setValue (const std::string &name, const boost::any &value)
| Sets a value of a property that has setter. More...
bool | isReadable (const std::string &name) const
| Check whether a property is readable. More...
bool | isWriteable (const std::string &name) const
| Check whether a property is writable. More...
void | setGetter (const std::string &name, GetterType func)
| Sets a getter for a given property. More...
void | setSetter (const std::string &name, SetterType func)
| Sets a setter for a given property. More...
void | setAccessors (const std::string &name, GetterType getter, SetterType setter)
| Sets the accessors getter and setter in one function. More...
void | removeAccessors (const std::string &name)
| Removes all the accessors (getter and setter) for a given property. More...
void | forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
| Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
void | setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
| Sets the functions used to convert data from and to a YAML::Node. More...
void | setDecoder (const std::string &name, DecoderType decoder)
| Sets the functions used to convert data from a YAML::Node. More...
YAML::Node | encode () const
| Encode this Accessible to a YAML::Node. More...
void | decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
| Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
template<>
boost::any | getValue (const std::string &name) const

## Protected Member Functions

bool | doLoad (const std::string &filePath) override
| Derived classes will overwrite this method to do actual loading. More...

## Private Attributes

osg::ref_ptr< osgText::Font > | m_font
| Osg pointer to the font structure. More...

## Additional Inherited Members

Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)> | GetterType
typedef std::function< void(boost::any)> | SetterType
typedef std::function< YAML::Node(void)> | EncoderType
typedef std::function< void(const YAML::Node *)> | DecoderType
Public Types inherited from SurgSim::Framework::FactoryBase< Asset >
typedef ObjectFactory< Asset > | FactoryType
Static Public Member Functions inherited from SurgSim::Framework::FactoryBase< Asset >
static FactoryType & | getFactory ()

## Detailed Description

Osg specialization of the Font class, supports osgText::Font.

## Constructor & Destructor Documentation

## OsgFont()

SurgSim::Graphics::OsgFont::OsgFont | ( |  | ) |

Constructor.

## ~OsgFont()

SurgSim::Graphics::OsgFont::~OsgFont | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## doLoad()

bool SurgSim::Graphics::OsgFont::doLoad | ( | const std::string & | filePath | ) |

override protected virtual

Derived classes will overwrite this method to do actual loading.

Note
  This method is not required to do any check on the validity or the existence of the file.

Parameters

  filePath | Absolute path to the file.

Returns
  True if loading is successful; Otherwise, false.

Implements SurgSim::Framework::Asset.

## getOsgFont()

osg::ref_ptr< osgText::Font > SurgSim::Graphics::OsgFont::getOsgFont | ( |  | ) | const

Returns
  the appropriate osgText::Font reference

## SURGSIM_CLASSNAME()

SurgSim::Graphics::OsgFont::SURGSIM_CLASSNAME | ( | SurgSim::Graphics::OsgFont |  | ) |

## Member Data Documentation

## m_font

osg::ref_ptr<osgText::Font> SurgSim::Graphics::OsgFont::m_font

private

Osg pointer to the font structure.

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

- SurgSim/Graphics/OsgFont.h
- SurgSim/Graphics/OsgFont.cpp