IG::ISymbolsPlane Class
Header: | #include <UnigineIGInterface.h> |
This class represents the IG Symbols Plane interface. A symbol surface (plane) is a rectangular, two-dimensional drawing region on a virtual plane on which symbols may be drawn. Such plane is placed in 3D space relative to a particular entity or coincident with the near clipping plane of a particular view.
IG plugin must be loaded.
ISymbolsPlane Class
Members
int getID ( ) #
Returns the plane identifier.Return value
Identifier of the plane.void addSymbol ( ISymbol * symbol ) #
Adds the specified symbol to the plane.Arguments
- ISymbol * symbol - ID of the symbol.
void setBillboard ( bool enable, bool fixed_scale ) #
Toggles on and off the plane orientation to the viewer and fixing the plane size regardless of the distance to it.Arguments
- bool enable - 1 to make the plane a billboard (always oriented to the viewer), 0 to disable orientation to the viewer.
- bool fixed_scale - 1 to make the billboard size unchanged regardless of its distance from the viewer, 0 — to disable.
bool isBillboard ( ) #
Checks if a node is a billboard (always oriented to the viewer).Return value
1 if a node is a billboard, otherwise 0.bool isFixedBillboardScale ( ) #
Checks if the billboard size is fixed relative to the viewer regardless of the distance.Return value
1 if the billboard scale is fixed, otherwise 0.void setPosition ( const vec3 & value ) #
Sets the plane position relative to the entity, if the plane has a parent entity.Arguments
- const vec3 & value - Position in the coordinate system of a parent entity.
void setRotation ( const quat & rotate ) #
Sets the plane rotation relative to the parent entity. The method is not applicable to billboards.Arguments
- const quat & rotate - Rotation quaternion for the plane
void setPhysicalSize ( float width, float heigth ) #
Sets the plane size for planes that have a parent entity.Arguments
- float width
- float heigth
void setUVSize ( float minU, float minV, float maxU, float maxV ) #
Sets the symbol surface 2D coordinate system.Arguments
- float minU - Minimum U value of the symbol surface.
- float minV - Minimum V value of the symbol surface.
- float maxU - Maximum U value of the symbol surface.
- float maxV - Maximum V value of the symbol surface.
void setScreenSize ( float width, float heigth, float offsetX, float offsetY ) #
Sets the screen plane resolution and offset in pixels.Arguments
- float width - Width of the screen plane, in pixels.
- float heigth - Height of the screen plane, in pixels.
- float offsetX - Horizontal offset of the screen plane.
- float offsetY - Vertical offset of the screen plane.
Last update:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)