Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics
[Home] [Tutorials] [All Classes] [Grouped Classes]

vl::Billboard Class Reference

A Transform that aligns an Actor towards the camera. More...

#include <Billboard.hpp>

Inheritance diagram for vl::Billboard:

vl::Transform vl::Object

List of all members.

Public Member Functions

 Billboard ()
virtual const char * className ()
 Returns the name of the class.
void setPosition (const vec3 &pos)
 The billboard position and rotation center.
void setPosition (Real x, Real y, Real z)
 The billboard position and rotation center.
vec3 position ()
 The billboard position and rotation center.
void setAxis (const vec3 &axis)
 The rotation axis in world coordinates. Used only for axis aligned billboards.
const vec3axis () const
 The rotation axis in world coordinates. Used only for axis aligned billboards.
void setNormal (const vec3 &normal)
 Used only for axis aligned billboards.
const vec3normal () const
 Used only for axis aligned billboards.
virtual void computeWorldMatrix (Camera *camera=NULL)
EBillboardType type () const
 The type of the billboard.
void setType (EBillboardType type)
 The type of the billboard.

Protected Attributes

vec3 mAxis
vec3 mNormal
EBillboardType mType


Detailed Description

A Transform that aligns an Actor towards the camera.

Constructor & Destructor Documentation

Billboard::Billboard (  ) 


Member Function Documentation

virtual const char* vl::Billboard::className (  )  [inline, virtual]

Returns the name of the class.

Reimplemented from vl::Transform.

void Billboard::setPosition ( const vec3 pos  ) 

The billboard position and rotation center.

void vl::Billboard::setPosition ( Real  x,
Real  y,
Real  z 
) [inline]

The billboard position and rotation center.

vec3 Billboard::position (  ) 

The billboard position and rotation center.

void vl::Billboard::setAxis ( const vec3 axis  )  [inline]

The rotation axis in world coordinates. Used only for axis aligned billboards.

const vec3& vl::Billboard::axis (  )  const [inline]

The rotation axis in world coordinates. Used only for axis aligned billboards.

void vl::Billboard::setNormal ( const vec3 normal  )  [inline]

Used only for axis aligned billboards.

const vec3& vl::Billboard::normal (  )  const [inline]

Used only for axis aligned billboards.

void Billboard::computeWorldMatrix ( Camera camera = NULL  )  [virtual]

Reimplemented from vl::Transform.

EBillboardType vl::Billboard::type (  )  const [inline]

The type of the billboard.

void vl::Billboard::setType ( EBillboardType  type  )  [inline]

The type of the billboard.


Member Data Documentation


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

Visualization Library v2009.08 Reference Documentation
Copyright 2005-2009 Michele Bosi. All rights reserved.
Updated on Tue Dec 29 13:56:54 2009.
Permission is granted to use this page to write and publish articles regarding Visualization Library.