VRS::Halo Class Reference

Attribute for shading geometry with a transparent halo. More...

#include <vrs/halo.h>

Inheritance diagram for VRS::Halo:

List of all members.

Public Member Functions
	Halo (const Color &=Color(1.0, 0.0, 0.0, 0.3), double size=STANDARD_HALO_SIZE)
void	setColor (const Color &)
	Sets the color of the halo.
Color	getColor () const
	Return the color of the halo.
void	setSize (double)
	Sets the size of the halo. Must be greater than zero.
double	getSize () const
	returns the size of the halo.
	VRS_TYPEINFO (Halo, MonoAttribute)
	VRS_SERIALIZABLE (Halo)
Static Public Attributes
static const double	STANDARD_HALO_SIZE
	The standard halo size is 0.01, i.e. just a tad larger than the shape itself.

---

Detailed Description

Attribute for shading geometry with a transparent halo.

---

Constructor & Destructor Documentation

VRS::Halo::Halo	(	const Color &	= Color(1.0, 0.0, 0.0, 0.3),
		double	size = STANDARD_HALO_SIZE
	)

Renders a shape with a halo, i.e, a transparent shine upon and around a shape. The size of the halo must be greater than zero, such that the halo is around the shape and visible.

The halo is calculated in direction of the normal using a vertex program, therefore for rendering a halo, the geometry must provide normals.

---

Member Function Documentation

void VRS::Halo::setColor

(

const Color &

)

Sets the color of the halo.

Color VRS::Halo::getColor

(

)

const

Return the color of the halo.

void VRS::Halo::setSize

(

double

)

Sets the size of the halo. Must be greater than zero.

double VRS::Halo::getSize

(

)

const

returns the size of the halo.

VRS::Halo::VRS_TYPEINFO	(	Halo	,
		MonoAttribute
	)

VRS::Halo::VRS_SERIALIZABLE

(

Halo

)

---

Member Data Documentation

const double VRS::Halo::STANDARD_HALO_SIZE [static]

The standard halo size is 0.01, i.e. just a tad larger than the shape itself.

---

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

• halo.h