A structure which describes the attributes of a Vg3DModule::VgLine.
Below is a code snippet showing how an allocated VgPointDescriptor can be configured:
...
VgApplication::VgIApplication* mVgApplication;
...
Vg3DModule::VgLineDescriptor lLineDesc;
const float lTextureSize = 1.0;
lLineDesc.
mWidths.push_back(lTextureSize);
...
- Version
- 2.0
| Vg3DModule::VgLineDescriptor::VgLineDescriptor |
( |
| ) |
|
|
inlineprotected |
| Vg3DModule::VgLineDescriptor::VgLineDescriptor |
( |
const VgLineDescriptor & |
pOther | ) |
|
|
inlineprotected |
| virtual Vg3DModule::VgLineDescriptor::~VgLineDescriptor |
( |
| ) |
|
|
protectedvirtual |
Creates a new descriptor by copyiong another one.
- Returns
- The pointer to the copy.
- Version
- 2.0.8955
This method returns a heap-allocated copy of a descriptor. It is one of the only two methods 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.
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.
The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements. Default is eAbsolute.
The line colors. This vector should contain either 1 element in which case all the line will be drawn using that color. If the vector's size is greater or equal to the size of VgLineDescriptor::mPositions, then one color element will be used for each position, and these will be interpolated by the spline erp.
- Note
- When using colors, the visibility ramps will not be able to adjust transparency, only binary (on/off) visibility is possible.
| bool Vg3DModule::VgLineDescriptor::mHaveCaps |
Tells whether the line should have round caps at start and end. Default value is false.
- Version
- 2.0.8955
| std::string Vg3DModule::VgLineDescriptor::mID |
The Line's identifier. Default value is empty string ("").
- See also
- VgEngine::VgQuery
- Version
- 2.1.0
-
2.1.3 Changed default to be empty string.
| VgLineType Vg3DModule::VgLineDescriptor::mLineType |
The type of line that will be rendered. Default value is eGeometryConstantSize.
| double Vg3DModule::VgLineDescriptor::mMaxCornerRadius |
This member sets the maximal curvature radius used in corners when smoothing the line. expressed in meters.
Default value is infinity, thus it will take wide turns if possible.
- Version
- 2.0.8955
| float Vg3DModule::VgLineDescriptor::mMinTesselationDist |
The line's minimum tesselation distance in meters. Smaller values induce smoother lines, but longer generation time. Default value is 1.0, but should be tuned to at most match line width.
- Version
- 2.1.12
The positions of the control points ordered sequentially. If you want to close the VgLine you have to push_back the first point at the end of the vector.
The texture that will be used when drawing the track. The texture mapping will ensure that the full texture width is mapped on the track's width.
- Note
- If using a texture, then VgLineDescriptor::mLineType should be set to eGeometryConstantSize.
| float Vg3DModule::VgLineDescriptor::mTextureAnimationSpeed |
The texture animation speed in meters/second (along the vertical axis of the texture). a zero or close-to-zero value (<1e-3) means no animation. Default value is 0.0f.
- Version
- 2.1.3 changed default value changed from 1.0 to 0.0f
| float Vg3DModule::VgLineDescriptor::mTextureSize |
The texture's size in y coordinate (metric). Default value is 1.0f.
| std::vector< double > Vg3DModule::VgLineDescriptor::mWidths |
The line widths. Depending on VgLineDescriptor::mLineType value these parameters can represent either pixel values (ePixelConstantSize) or meter values (eGeometryConstantSize). This vector should contain either 1 element in which case all the line will be drawn using that width. If the vector's size is greater or equal to the size of VgLineDescriptor::mPositions, then one width element will be used for each position, and these will be interpolated by the spline erp.
- Note
- In case the line is of ePixelConstantSize type, only the first element will be used as the overall width, whatever the vector's size is.
The documentation for this struct was generated from the following file:
Public Member Functions inherited from VgEngine::VgReferenced
