Detailed Description

Ultrasound fan illustration on 2D slice view.

See FrameGeometry for a detailed summary of the frame geometry concept.

Fan Geometries can be created from an existing UltrasoundSweep or FrameGeometry, and can be added to image views:

UltrasoundSweep us;
auto glFanGeom = std::make_unique<GlFanGeometry>(us);
ImageView3D view3d{};
view3d.view()->addObject(glFanGeom.get());
ImageView2D view2d(true, Slice::AnatomicalPlane::Axial);
view2d.view()->addObject(glFanGeom.get());

Public Member Functions
	GlFanGeometry (UltrasoundSweep &us)

	GlFanGeometry (const FrameGeometry &geom)

void	updatePoints (const FrameGeometry &geom)
	Must be called to update changes in geometry.

void	draw (const GlView &view) override
	Draw the annotation, when the geometry changes updatePoints() must be called.

void	setEdgeColors (std::optional< std::vector< vec4 > > c)
	If set, each fan edge is colored individually.

const FrameGeometry &	geometry () const
	Return the ultrasound geometry.

Geometry::AlignedBox	bounds () const override
	Returns the 3D bounds of the fan geometry.

std::string	typeName () const override
	Returns the id of this class.

const FrameGeometry::Fan &	fan () const
	Returns a reference to the internal fan.

const ImageDescriptor &	imgDesc () const
	Returns the image descriptor of the fan geometry to draw.

void	showControlPoints (bool show)
	Sets whether the control points of the fan are shown in the associated views.

Public Member Functions inherited from GlAnnotation
virtual void	setView (const GlView *view)
	Set the view through which this annotation is currently being manipulated.

virtual const GlView *	view () const
	Get the view through which this annotation is currently being manipulated.

virtual bool	hitTest (int, int, const GlView &) const
	Perform hit test with points of underlying object. Return true if object is hit, false otherwise.

virtual void	setEditable (bool editable)
	When a GlAnnotation is editable it may alter its visualization and render UI elements for its manipulation.

virtual bool	editable () const
	When a GlAnnotation is editable it may alter its visualization and render UI elements for its manipulation.

virtual void	setColor (const vec3 &color)
	Set annotation color.

virtual vec3	color () const
	Return annotation color.

virtual void	setAlpha (double v)
	Set alpha channel.

virtual double	alpha () const
	Get alpha channel.

virtual void	setLineWidth (float lineWidth)
	Set annotation line width.

virtual float	lineWidth () const
	Return annotation line width.

virtual void	setLabelVisible (bool visible)
	Set annotation label visibility.

virtual bool	labelVisible () const
	Return annotation label visibility.

virtual void	setLabelBackgroundVisible (bool visible)
	Set annotation label background visibility.

virtual bool	labelBackgroundVisible () const
	Return annotation label background visibility.

virtual void	setLabelBackgroundColor (vec4 color)
	Set annotation label background color.

virtual vec4	labelBackgroundColor () const
	Return annotation label background color.

virtual void	setLabelBackgroundMargin (int margin)
	Set annotation label background margin in pixels.

virtual int	labelBackgroundMargin () const
	Return annotation label background margin in pixels.

virtual void	setLabelDepthTest (bool depthTest)
	Set annotation label depth test flag.

virtual bool	labelDepthTest () const
	Return annotation label depth test flag.

virtual void	setLabelColor (const vec3 &color)
	Set annotation label color.

virtual vec3	labelColor () const
	Return annotation label color.

virtual void	setLabelText (const std::string &label)
	Set annotation label text.

virtual std::string	labelText () const
	Return annotation label text.

virtual void	setLabelTextPrefix (const std::string &labelPrefix)
	Set annotation label text prefix.

std::string	labelTextPrefix () const
	Return annotation label text prefix.

virtual void	setLabelTextSuffix (const std::string &labelSuffix)
	Set annotation label text suffix.

std::string	labelTextSuffix () const
	Return annotation label text suffix.

virtual void	setName (const std::string &name)
	Set annotation name.

virtual std::string	name () const
	Return annotation name.

void	configure (const Properties *p) override
	Set one or multiple properties.

void	configuration (Properties *p) const override
	Retrieve the properties of this object.

virtual void	setSelected (bool m)
	When a GlAnnotation is selected, it may be rendered differently to distinguish it from non-selected annotations.

bool	selected () const
	When a GlAnnotation is selected, it may be rendered differently to distinguish it from non-selected annotations.

virtual void	setMatrixWithoutMoving (const mat4 &m)
	Change the matrix without moving the annotation, e.g. for linking it with an image transformation.

void	copyStyle (const GlAnnotation &other)
	Copies the settable parameters from another GlAnnotation.

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

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 Member Functions inherited from GlAnnotation
void	renderLabel (const GlView &view, const vec3 &positionWorld) const
	Render the label of the annotation at the given position.

vec2i	labelSize () const

Protected Attributes inherited from GlAnnotation
bool	m_editable = true

vec4	m_color {1, 1, 0, 1}

float	m_lineWidth = 1

bool	m_labelVisible = true

bool	m_labelBackgroundVisible = false

vec4	m_labelBackgroundColor {0.3, 0.3, 0.3, 0.7}

int	m_labelBackgroundMargin = 3

bool	m_labelDepthTest = true

bool	m_selected = false

vec3	m_labelColor {0, 1, 1}

std::string	m_labelText

std::string	m_labelTextPrefix

std::string	m_labelTextSuffix

const GlView *	m_view = nullptr

std::string	m_name

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.

Member Function Documentation

◆ draw()

void draw ( const GlView & view )

overridevirtual

Draw the annotation, when the geometry changes updatePoints() must be called.

Implements GlObject.

◆ bounds()

Geometry::AlignedBox bounds ( ) const

overridevirtual

Returns the 3D bounds of the fan geometry.

Implements GlObject.

◆ typeName()

std::string typeName ( ) const

inlineoverridevirtual

Returns the id of this class.

Implements GlObject.

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

ImFusion/US/GlFanGeometry.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ draw()

◆ bounds()

◆ typeName()