ImFusion::GlRectangleBillboard Class Reference

#include <ImFusion/GL/GlRectangleBillboard.h>

Renders a fixed size rectangle billboard in the world, always facing towards the camera. More...

Inheritance diagram for ImFusion::GlRectangleBillboard:

Detailed Description

Renders a fixed size rectangle billboard in the world, always facing towards the camera.

The size of the rectangle is specified in pixels, for the size of the side of the rectangle. It is always looking towards the view, without depth test, at the position in the world defined with GlObject::setMatrix. It can be rotated in the view by applying a rotation along the Z axis on the given matrix.

Public Member Functions
	GlRectangleBillboard (vec2i size)
	GlRectangleBillboard (int width, int height)
virtual void	draw (const GlView &view) override
	Draw the object in 3D space.
virtual Geometry::AlignedBox	bounds () const override
	Get the axis-aligned bounding box of this GlObject in world space.
virtual std::string	typeName () const override
	Return unique identifier for this object class used for serialization.
void	setSize (vec2i size)
	Sets the size of the rectangle, in pixels.
void	setLineWidth (double width)
	Sets the line width.
void	setLineColor (vec4 color)
	Sets the line color.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from ImFusion::GlObject
virtual Geometry::AlignedBox	boundsSpherical () const
	Get the spherical bounds of this GlObject in world space.
virtual void	setMatrix (const mat4 &m)
	Set the modelview matrix of this object.
virtual const mat4 &	matrix () const
	Return the modelview matrix.
virtual void	setVisible (bool visible)
	Set object visibility.
virtual bool	visible () const
	Return object visibility.
virtual void	setAlwaysVisible (bool alwaysVisible)
	Set if object is always visible.
virtual bool	alwaysVisible () const
	Return if object is always visible.
RenderingOrderGroup	renderingOrder () const
	Return current rendering order value for this GlObject.
void	setRenderingOrder (RenderingOrderGroup group)
	Set rendering order value for this GlObject.
void	setDraw3DIn2DView (bool draw3DIn2DView)
Public Member Functions inherited from ImFusion::Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Additional Inherited Members
Public Types inherited from ImFusion::GlObject
enum	RenderingOrderGroup { RenderingGroupRest , RenderingGroupMesh , RenderingGroupManipulator }
	Enumeration to determine rendering order of GlObjects in GlSliceView and GlVolumeView. More...
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Attributes inherited from ImFusion::GlObject
mat4	m_matrix = mat4::Identity()
	Modelview transformation matrix of this object.
bool	m_visible = true
	Object visibility.
bool	m_alwaysVisible = false
	Object always visible.
bool	m_draw3DIn2DView
	Draw 3D objects in 2D views. This is to render 3D objects in projective 2D views. Property is not serialized.
RenderingOrderGroup	m_renderingOrder = RenderingGroupRest
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

draw()

virtual void ImFusion::GlRectangleBillboard::draw ( const GlView & view )

overridevirtual

Draw the object in 3D space.

Implements ImFusion::GlObject.

bounds()

virtual Geometry::AlignedBox ImFusion::GlRectangleBillboard::bounds ( ) const

overridevirtual

Get the axis-aligned bounding box of this GlObject in world space.

Return an empty (default-constructed) AlignedBox object if the GlObject does not reside in world space.

Implements ImFusion::GlObject.

typeName()

virtual std::string ImFusion::GlRectangleBillboard::typeName ( ) const

overridevirtual

Return unique identifier for this object class used for serialization.

Implements ImFusion::GlObject.

configure()

void ImFusion::GlRectangleBillboard::configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from ImFusion::GlObject.

configuration()

void ImFusion::GlRectangleBillboard::configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from ImFusion::GlObject.

---

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

• ImFusion/GL/GlRectangleBillboard.h