ImFusion C++ SDK 4.4.0
ImFusion::FreeformAnnotationManipulator Class Reference

#include <ImFusion/GUI/FreeformAnnotationManipulator.h>

Manipulator for freeform annotations. More...

Inheritance diagram for ImFusion::FreeformAnnotationManipulator:

Detailed Description

Manipulator for freeform annotations.

Public Member Functions

 FreeformAnnotationManipulator (GlFreeform &annotation)
bool sceneEvent (QEvent *event, const GlView &view) override
void setPenCursor ()
void setHoverCursor () override
 Sets cursor to open hand.
void setInteractionCursor () override
 Sets cursor to closed (grabbing) hand.
void setEndOnRelease (bool v)
void setResetModeAfterEdit (bool v)
void set3dPicking (bool picking)
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 ImFusion::PointBasedAnnotationManipulator
 PointBasedAnnotationManipulator (GlPointBasedAnnotation &annotation)
bool sceneEvent (QEvent *event, const GlView &view) override
virtual bool sceneEvent3D (const MouseEvent &ev, const GlVolumeView &view)
bool get3dPos (const MouseEvent &ev, const GlVolumeView &view, vec3 &result)
virtual void setInteractionMode (PointBasedAnnotationManipulator::InteractionMode mode, bool finalize=true)
 Sets the interaction mode.
InteractionMode interactionMode () const
 Returns the interactions mode.
void setAllowedInteractions (Flags< PointBasedAnnotationManipulator::InteractionMode > allowedInteractions)
 Sets allowed interactions.
Flags< PointBasedAnnotationManipulator::InteractionMode > allowedInteractions () const
 Returns the allowed interactions.
void setHovering (bool hovering)
 Sets the hovering behavior (i.e.
bool hovering () const
 Returns whether hovering support is enabled.
void reset ()
 Resets all parameters to their default value.
void setPoints (const std::vector< vec3 > &points)
void setAxisManip (int axis)
 Set axis along which points can be moved. Point coordinates will be fixed on other axes. Only applies to move and edit interactions.
void clearAxisManip ()
 Make point movable along all axes.
void setBounds (double x0, double x1, double y0, double y1, double z0, double z1)
 Set bounds for allowed point coordinates.
void clearBounds ()
 Clear bounds.
MouseEvent::Button lastButton () const
 Return button with which last interaction was performed.
void resetCursor ()
 Resets cursor to default.
void setInteractiveAnnotation (InteractiveAnnotation *annot)
bool requiresFocus () override
 Derived classes that need priority scene events can override this.
void setVolumeViewPickingMode (VolumeViewPickingMode pickingMode)
void setChangeCursorOnEdit (bool change)
Qt::Key finishCreationKey () const
void setFinishCreationKey (Qt::Key key)
Qt::Key abortCreationKey () const
void setAbortCreationKey (Qt::Key key)
Public Member Functions inherited from ImFusion::Manipulator
void addListener (ManipulatorListener *listener)
void removeListener (const ManipulatorListener *listener)
virtual void openContextMenu (QPoint pos, QPoint globalPos, Qt::KeyboardModifiers modifiers)
GUI::EventResult handleInputEvent (const GUI::InputEvent &event, const GUI::View &view) override
 This function is called by sources of input events in order to dispatch them to the handlers.
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)
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::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 Member Functions

virtual bool onCreate (const MouseEvent &event, vec3 &X, bool &update)
Protected Member Functions inherited from ImFusion::PointBasedAnnotationManipulator
virtual InteractionMode selectInteraction (const MouseEvent &ev, bool hitLine)
 Selects the next interaction given the mouse event and hitLine.
virtual bool onCreate (const MouseEvent &event, vec3 &X, bool &update, const GlView &view)
 Handler for mouse events in the InteractionCreate mode.
virtual bool onMove (const MouseEvent &event, vec3 &X, bool &update)
 Handler for mouse events in the InteractionMove mode.
virtual bool onRemove (const MouseEvent &event, vec3 &X, bool &update)
 Handler for mouse events in the InteractionRemove mode.
virtual bool onScale (const MouseEvent &event, vec3 &X, bool &update)
 Handler for mouse events in the InteractionScale mode.
virtual bool onRotate (const MouseEvent &event, vec3 &X, bool &update, const GlView &view)
 Handler for mouse events in the InteractionRotate mode.
void finalizeInteraction ()
virtual bool pickingNeeded ()
bool computeCursorMeshIntersection (const MouseEvent &event, const GlVolumeView &view, const GlMesh *mesh, vec3 &result)
void enablePicking (GlVolumeView &view)
void disablePicking ()
Protected Member Functions inherited from ImFusion::Manipulator
void notifyListeners (void *eventData)

Additional Inherited Members

Public Types inherited from ImFusion::PointBasedAnnotationManipulator
enum  InteractionMode {
  InteractionNone = 0 , InteractionCreate = 1 , InteractionMove = 2 , InteractionAdd = 4 ,
  InteractionRemove = 8 , InteractionEdit = 16 , InteractionScale = 32 , InteractionRotate = 64
}
enum class  VolumeViewPickingMode { On , Off , Automatic }
 Enumeration to describe when PointBasedAnnotationManipulator should perform 3D position picking in GlVolumeViews. More...
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::PointBasedAnnotationManipulator
Signal< const PointBasedAnnotationManipulator * > signalCreatingFinished
 Emitted when the manipulator leaves the InteractionCreate mode.
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::PointBasedAnnotationManipulator
GlPointBasedAnnotationm_annotation
GlObject::RenderingOrderGroup m_originalAnnotationRenderingOrder = GlObject::RenderingGroupRest
vec3 m_pos0
int m_selectedPoint
InteractionModeWrapper m_interactionMode
Flags< InteractionMode > m_allowedInteractions
bool m_hovering
std::vector< vec3 > m_points0
int m_axisManip
bool m_useBounds
double m_bounds [6]
bool m_changeCursorOnEdit = false
bool m_interactionCursor = false
bool m_hoverCursor = false
bool m_wantsFocus
bool m_suppressNextContextMenuEvent
 If true, the context menu is not shown after right mouse release (usually set after a move).
bool m_isPressed = false
VolumeViewPickingMode m_3dPickingMode = VolumeViewPickingMode::On
InteractiveAnnotationm_interactiveAnnotation
vec3 m_center
vec2i m_mouse0
vec2i m_mouse
vec3 m_depthAxis
vec3 m_xAxis
vec3 m_yAxis
std::unique_ptr< GlVolumeView::PickingTokenm_pickingToken
std::map< GlMesh *, int > m_originalMeshPickingModes
MouseEvent::Button m_lastButton
Qt::Key m_abortCreationKey
Qt::Key m_finishCreationKey
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< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ sceneEvent()

bool ImFusion::FreeformAnnotationManipulator::sceneEvent ( QEvent * event,
const GlView & view )
overridevirtual

Implements ImFusion::Manipulator.

◆ setHoverCursor()

void ImFusion::FreeformAnnotationManipulator::setHoverCursor ( )
overridevirtual

Sets cursor to open hand.

Reimplemented from ImFusion::PointBasedAnnotationManipulator.

◆ setInteractionCursor()

void ImFusion::FreeformAnnotationManipulator::setInteractionCursor ( )
overridevirtual

Sets cursor to closed (grabbing) hand.

Reimplemented from ImFusion::PointBasedAnnotationManipulator.

◆ draw()

void ImFusion::FreeformAnnotationManipulator::draw ( const GlView & view)
overridevirtual

Draw the object in 3D space.

Implements ImFusion::GlObject.

◆ bounds()

Geometry::AlignedBox ImFusion::FreeformAnnotationManipulator::bounds ( ) const
inlineoverridevirtual

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()

std::string ImFusion::FreeformAnnotationManipulator::typeName ( ) const
inlineoverridevirtual

Return unique identifier for this object class used for serialization.

Implements ImFusion::GlObject.


The documentation for this class was generated from the following file:
  • ImFusion/GUI/FreeformAnnotationManipulator.h
Search Tab / S to search, Esc to close