Describes a text marker. More...
Public Member Functions | |
| const VgMarkerType | getType () const |
Static Public Member Functions | |
| static VgEngine::VgRefPtr < Vg3DModule::VgTextMarkerDescriptor > | create () |
| This static method returns a new heap-allocated descriptor. | |
Public Attributes | |
| std::string | mText |
| The POI's label. | |
| unsigned int | mTextAttributesMask |
| Text attributes. | |
| VgEngine::VgColor | mColor |
| The text's color. | |
| double | mScale |
| Controls the size of the POI in meters, by default 70.0. | |
Protected Member Functions | |
| VgTextMarkerDescriptor () | |
| Constructor. | |
| virtual | ~VgTextMarkerDescriptor () |
| Destructor. | |
Detailed Description
Describes a text marker.
The text will be displayed at the point associated.
- Version:
- 2.0
Constructor & Destructor Documentation
| Vg3DModule::VgTextMarkerDescriptor::VgTextMarkerDescriptor | ( | ) | [inline, protected] |
Constructor.
| virtual Vg3DModule::VgTextMarkerDescriptor::~VgTextMarkerDescriptor | ( | ) | [protected, virtual] |
Destructor.
Member Function Documentation
| static VgEngine::VgRefPtr< Vg3DModule::VgTextMarkerDescriptor > Vg3DModule::VgTextMarkerDescriptor::create | ( | ) | [static] |
This static method returns a new heap-allocated descriptor.
It is the only method that should be used to instantiate new descriptors. It is a way to make sure no one will delete it, except the last VgRefPtr pointing to it.
| const VgMarkerType Vg3DModule::VgTextMarkerDescriptor::getType | ( | ) | const [inline, virtual] |
- Returns:
- the type of marker
Implements Vg3DModule::VgMarkerDescriptor.
Member Data Documentation
The text's color.
Controls the size of the POI in meters, by default 70.0.
The visible size can also be determined by the distance of the POI from the camera, see the property mGeometryConstantSizeDistance.
| std::string Vg3DModule::VgTextMarkerDescriptor::mText |
The POI's label.
If an icon is defined, the icon will be placed on the left side of the label, with horizontal centers aligned By default this property is an empty string.
Text attributes.
You specify the value of this mask by combining the constants described in VgEngine::VgTextAttributes using the C bitwise OR operator. Combining these constants lets you specify which attributes should be associated with the text. The default value of this property is eTextAttributeNone.
The documentation for this struct was generated from the following file:
- VgTextMarkerDescriptor.h