ImFusion SDK 4.3
GlImageHighlighter Class Reference

#include <ImFusion/GL/GlImageHighlighter.h>

GlObject that highlights an image by drawing a colored layer on top of it. More...

+ Inheritance diagram for GlImageHighlighter:

Detailed Description

GlObject that highlights an image by drawing a colored layer on top of it.

The intensity of the color layer is multiplied by the intensity of the image in the corresponding shader. SharedImageSets can be added to/removed from this class via the addImage/removeImage methods.

Public Member Functions

void draw (const GlView &view) override
 Draw the object in 3D space.
 
Geometry::AlignedBox bounds () const override
 Returns empty bounds, use bounds of images if needed.
 
std::string typeName () const override
 Return unique identifier for this object class used for serialization.
 
void setColor (const vec4 &color)
 Sets the color and the opacity of the highlighter.
 
vec4 color ()
 
void addImage (const SharedImageSet *toAddImage)
 Adds a SharedImageSet to the vector of images to be highlighted.
 
void removeImage (const SharedImageSet *toRemoveImage)
 Removes a SharedImageSet from the vector of images to be highlighted.
 
void setImages (const std::vector< const SharedImageSet * > &images)
 Sets the list of images to be highlighted.
 
std::vector< const SharedImageSet * > images () const
 Returns the vector of pointers to the image sets that are currently highlighted.
 
- Public Member Functions inherited from 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)
 
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 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Additional Inherited Members

- Public Types inherited from GlObject
enum  RenderingOrderGroup { RenderingGroupRest , RenderingGroupMesh , RenderingGroupManipulator }
 Enumeration to determine rendering order of GlObjects in GlSliceView and GlVolumeView. More...
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 
- Protected Attributes inherited from 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 Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ draw()

void draw ( const GlView & view)
overridevirtual

Draw the object in 3D space.

Implements GlObject.

◆ bounds()

Geometry::AlignedBox bounds ( ) const
overridevirtual

Returns empty bounds, use bounds of images if needed.

Implements GlObject.

◆ typeName()

std::string typeName ( ) const
overridevirtual

Return unique identifier for this object class used for serialization.

Implements GlObject.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close