Detailed Description

GlObject to render an UltrasoundSweep in 3D Views.

Public Member Functions
void	setSweeps (const std::vector< UltrasoundSweep * > &value)
	Sets the list of UltrasoundSweeps to display.

const std::vector< UltrasoundSweep * > &	sweeps () const
	Returns the list of UltrasoundSweeps to display.

void	setCustomDisplayOptions (const SweepDisplayOptions sweepDisplayOptions, const DisplayOptions3d displayOptions3d)
	Sets optional custom display options to use instead of the ones attached to the input sweep.

std::pair< const SweepDisplayOptions , const DisplayOptions3d >	customDisplayOptions () const
	Returns the optional custom display options used instead of the ones attached to the input sweep.

const vec4f &	outlineColor () const
	Returns the render color of the outline if showOutline is on.

void	setOutlineColor (const vec4f &value)
	Sets the render color of the outline if showOutline is on.

const vec4f &	focusColor () const
	Returns the render color of the focus outline if showFocus is on.

void	setFocusColor (const vec4f &value)
	Sets the render color of the focus outline if showFocus is on.

int	oitFrameLimit () const
	Returns the maximum number of rendered frames for which to use order-independent transparency if available.

void	setOitFrameLimit (int value)
	Sets the maximum number of rendered frames for which to use order-independent transparency if available.

void	setShowAll (bool flag)
	Denote if selection shall be ignored, i.e. all frames are shown.

bool	showAll ()
	Return if selection shall be ignored, i.e. all frames are shown.

void	setShowOutline (bool outline)
	Show outline only instead of sweep frame.

bool	showOutline ()
	Return if outline only instead of sweep frame is shown.

void	setShowFocusOutline (bool outline)
	Show outline of focus frame.

bool	focusOutline ()
	Return if outline of focus frame is shown.

void	setShowNumImages (int numImages)
	Set maximum number of images to show (independent of sweep size)

int	showNumImages ()
	Return maximum number of images to show (independent of sweep size)

void	draw (const GlView &view) override
	Draw the object in 3D space.

Geometry::AlignedBox	bounds () const override
	Get the axis-aligned bounding box of this GlObject in world space.

std::string	typeName () const override
	Return unique identifier for this object class used for serialization.

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

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Protected Attributes
std::vector< UltrasoundSweep * >	m_sweeps
	List of UltrasoundSweeps to display.

std::unique_ptr< GL::VertexBuffer >	m_vbo
	VBO for rendering.

std::unique_ptr< GL::ProgramCache >	m_progManager
	Manager for sweep rendering shaders.

const SweepDisplayOptions *	m_customSDO = nullptr
	Optional custom display options to use instead the input sweep ones.

const DisplayOptions3d *	m_customDO3d = nullptr
	Optional custom display options to use instead the input sweep ones.

vec4f	m_outlineColor = vec4f(1.f, 1.f, 1.f, 2.f / 255.f)
	Render color of the outline if showOutline is on.

vec4f	m_focusColor = vec4f(1.f, 0.f, 0.f, 2.f / 255.f)
	Render color of the outline of the focus if showFocus is on.

bool	m_showFocus = false
	Emphasize the focus plane in addition.

bool	m_showOutline = false
	Show only slice outlines, not the actual textures.

int	m_showNumImages = 0
	Show N images only.

int	m_oitFrameLimit = 250
	Maximum number of rendered frames for which OIT is used if available.

bool	m_showAll = false
	Show all frames regardless of selection.

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< Param >	m_params
	List of all registered Parameter and SubProperty instances.

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.

Member Function Documentation

◆ setOitFrameLimit()

void setOitFrameLimit ( int value )

inline

Sets the maximum number of rendered frames for which to use order-independent transparency if available.

Using OIT with large sweeps can lead to significantly decreased performance due to the large number of semi-transparent fragments and the resulting GPU memory requirements.

See also: GL::OrderIndependentTransparency

◆ draw()

void draw ( const GlView & view )

overridevirtual

Draw the object in 3D space.

Implements GlObject.

◆ bounds()

Geometry::AlignedBox 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 GlObject.

◆ typeName()

std::string typeName ( ) const

inlineoverridevirtual

Return unique identifier for this object class used for serialization.

Implements GlObject.

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

ImFusion/US/GlSweep3D.h

Detailed Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ setOitFrameLimit()

◆ draw()

◆ bounds()

◆ typeName()