cee::vis::MarkupPartFixedSizeGlyph Class Reference

A MarkupModel part for drawing a fixed size glyph (2d billboard). More...

Public Member Functions

 MarkupPartFixedSizeGlyph ()
 Constructs an empty part. More...
 
 MarkupPartFixedSizeGlyph (Image *image, const Vec3d &position, unsigned int pixelSizeLongestEdge)
 Constructs a part with the given image, position and size in pixels. More...
 
virtual PartType type () const
 Returns the type of the part. Always MarkupPart::FIXED_SIZE_IMAGE_GLYPH. More...
 
virtual BoundingBox boundingBox () const
 Returns the current bounding box of the part. More...
 
virtual void setPriority (int priority)
 Set render priority of the part. More...
 
virtual int priority () const
 Returns the render priority of the part. More...
 
virtual const Mat4dtransformation () const
 Returns the current transformation matrix for the part. More...
 
virtual void setTransformation (const Mat4d &matrix)
 Sets the transformation matrix to use for the part. More...
 
const Imageimage () const
 Returns the image of the glyph. More...
 
void setImage (Image *image)
 Sets the image to draw as the glyph. More...
 
Vec3d position () const
 Returns the position where the glyph is drawn. More...
 
void setPosition (const Vec3d &position)
 Sets the position of the glyph. More...
 
unsigned int pixelSizeLongestEdge () const
 Returns the size of the glyph (longest edge of the image) in pixels. More...
 
void setPixelSizeLongestEdge (unsigned int pixelSize)
 Sets the size of the glyph in pixels. More...
 
- Public Member Functions inherited from cee::vis::MarkupPart
bool visible () const
 Returns true if the part is visible. More...
 
void setVisible (bool visible)
 Sets if the part should be visible or not. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 

Additional Inherited Members

- Public Types inherited from cee::vis::MarkupPart
enum  PartType {
  LABELS, TEXTS_3D, TRIANGLES, INSTANCED_GEOMETRY,
  LINES, POINTS, ARROWS, FIXED_SIZE_ARROW,
  FIXED_SIZE_SPHERE, FIXED_SIZE_IMAGE_GLYPH
}
 Enum specifying the type of MarkupPart. More...
 
Inheritance diagram for cee::vis::MarkupPartFixedSizeGlyph:
cee::vis::MarkupPart cee::RefCountedObject

Detailed Description

A MarkupModel part for drawing a fixed size glyph (2d billboard).

This part is used to draw a 2D image of a fixed size (in pixels) in a 3D position in the scene.

See also
MarkupModel

Constructor & Destructor Documentation

cee::vis::MarkupPartFixedSizeGlyph::MarkupPartFixedSizeGlyph ( )

Constructs an empty part.

cee::vis::MarkupPartFixedSizeGlyph::MarkupPartFixedSizeGlyph ( Image image,
const Vec3d position,
unsigned int  pixelSizeLongestEdge 
)

Constructs a part with the given image, position and size in pixels.

Member Function Documentation

cee::BoundingBox cee::vis::MarkupPartFixedSizeGlyph::boundingBox ( ) const
virtual

Returns the current bounding box of the part.

Implements cee::vis::MarkupPart.

const Image * cee::vis::MarkupPartFixedSizeGlyph::image ( ) const

Returns the image of the glyph.

unsigned int cee::vis::MarkupPartFixedSizeGlyph::pixelSizeLongestEdge ( ) const

Returns the size of the glyph (longest edge of the image) in pixels.

cee::Vec3d cee::vis::MarkupPartFixedSizeGlyph::position ( ) const

Returns the position where the glyph is drawn.

int cee::vis::MarkupPartFixedSizeGlyph::priority ( ) const
virtual

Returns the render priority of the part.

Implements cee::vis::MarkupPart.

void cee::vis::MarkupPartFixedSizeGlyph::setImage ( Image image)

Sets the image to draw as the glyph.

void cee::vis::MarkupPartFixedSizeGlyph::setPixelSizeLongestEdge ( unsigned int  pixelSize)

Sets the size of the glyph in pixels.

The size is specified as the number of pixels of the longest edge (width or height) of the image.

void cee::vis::MarkupPartFixedSizeGlyph::setPosition ( const Vec3d position)

Sets the position of the glyph.

void cee::vis::MarkupPartFixedSizeGlyph::setPriority ( int  priority)
virtual

Set render priority of the part.

The render priority determines the order in which parts get rendered. Parts with lower priorities get rendered first. The default priority is 101.

Implements cee::vis::MarkupPart.

void cee::vis::MarkupPartFixedSizeGlyph::setTransformation ( const Mat4d matrix)
virtual

Sets the transformation matrix to use for the part.

Implements cee::vis::MarkupPart.

const Mat4d & cee::vis::MarkupPartFixedSizeGlyph::transformation ( ) const
virtual

Returns the current transformation matrix for the part.

Implements cee::vis::MarkupPart.

MarkupPart::PartType cee::vis::MarkupPartFixedSizeGlyph::type ( ) const
virtual

Returns the type of the part. Always MarkupPart::FIXED_SIZE_IMAGE_GLYPH.

Implements cee::vis::MarkupPart.