 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/GUI/InteractiveOrientationMeshOverlay.h>
The InteractiveOrientationMeshOverlay class wraps a GlOrientationMeshOverlay and does not provide any interactions. More...
Inheritance diagram for InteractiveOrientationMeshOverlay:The InteractiveOrientationMeshOverlay class wraps a GlOrientationMeshOverlay and does not provide any interactions.
Public Member Functions | |
| InteractiveOrientationMeshOverlay (const Mesh &mesh, InteractiveView *view, AnchorPoint anchor) | |
| Constructs a new InteractiveOrientationMeshOverlay with the given mesh. | |
| void | loadMesh (const Mesh &mesh) |
| Updates the mesh of the overlay. | |
| void | setBackgroundImage (std::unique_ptr< SharedImage > backgroundImage) |
| Set an optional background image to show behind the mesh. | |
| Public Member Functions inherited from InteractiveOverlay | |
| InteractiveOverlay (std::unique_ptr< GlOverlay > overlay, AnchorPoint anchor) | |
| Instantiate a new InteractiveOverlay taking ownership of the underlying GlOverlay. | |
| InteractiveOverlay (GlOverlay &overlay, AnchorPoint anchor) | |
| Instantiate a new InteractiveOverlay referencing the given overlay. | |
| InteractiveOverlay (GlOverlay *overlay, AnchorPoint anchor, bool ownOverlay=true) | |
| const GlOverlay * | overlay () const |
| Get a pointer to the underlying overlay. | |
| GlOverlay * | overlay () |
| Get a pointer to the underlying overlay. | |
| virtual void | setInteraction (std::unique_ptr< OverlayInteraction > interaction) |
| Set an interaction event handler for this overlay. | |
| QRect | rect () const |
| Get position and actual size (including margins) of overlay in viewport coordinates. | |
| void | setMargin (int horizontal, int vertical) |
| Sets the margin in pixels between the border of the drawing area and the border of the overlay content. | |
| int | horizontalMargin () const |
| Gets the horizontal margin in pixels between the border of the drawing area and the border of the overlay content. Default is 2. | |
| int | verticalMargin () const |
| Gets the vertical margin in pixels between the border of the drawing area and the border of the overlay content. Default is 2. | |
| virtual void | setSizeHint (int width, int height) |
| Sets the preferred size of the overlay for a DPI scaling of 1.0. | |
| virtual int | sizeHintWidth () const |
| Gets the preferred width of the overlay. | |
| virtual int | sizeHintHeight () const |
| Gets the preferred height of the overlay. | |
| virtual void | setMinimalSizeHint (int width, int height) |
| Sets the minimal size of the overlay for a DPI scaling of 1.0. | |
| virtual int | minimalSizeHintWidth () const |
| Gets the minimal width of the overlay. | |
| virtual int | minimalSizeHintHeight () const |
| Gets the minimal height of the overlay. | |
| void | setAnchorPoint (AnchorPoint anchorPoint) |
| Set the anchor point of overlay. | |
| AnchorPoint | anchorPoint () const |
| Get the anchor point of overlay. | |
| virtual bool | sceneEvent (QEvent *event) |
| Called by the hosting InteractiveView, default implementation forwards it to the set OverlayInteraction. | |
| GUI::EventResult | handleInputEvent (const GUI::InputEvent &event) override |
| Calls the base interface's version and then continues propagation to sceneEvent(). | |
| Public Member Functions inherited from ViewOverlay | |
| ViewOverlay (std::unique_ptr< GlOverlay > glOverlay) | |
| Instantiate a new ViewOverlay taking ownership of the underlying GlOverlay which must not be null. | |
| virtual void | render () |
| Calls GlOverlay::render() on the underlying glOverlay() using the current viewport() shrinked by margin(). | |
| const GlOverlay & | glOverlay () const |
| Get a pointer to the underlying overlay. | |
| GlOverlay & | glOverlay () |
| Get a pointer to the underlying overlay. | |
| const GL::Viewport & | viewport () |
| Returns the area where this overlay is rendered. | |
| bool | isVisible () const |
| Returns the visibility of this overlay. | |
| virtual void | setVisible (bool value) |
| Sets the visibility of this overlay. | |
| const vec2i & | margin () const |
| Returns the margin in pixels between the border of the drawing area and the border of the overlay content. | |
| void | setMargin (const vec2i &value) |
| Sets the margin in pixels between the border of the drawing area and the border of the overlay content. | |
| vec2i | minimalSizeHint () const |
| Returns the underlying GlOverlay's minimal size hint plus the configured margin(). | |
| vec2i | sizeHint () const |
| Returns the underlying GlOverlay's size hint plus the configured margin(). | |
| 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 |
| Public Member Functions inherited from SignalReceiver | |
| SignalReceiver ()=default | |
| Default constructor. | |
| SignalReceiver (const SignalReceiver &other) | |
| Copy constructor, does not copy any existing signal connections from other. | |
| SignalReceiver & | operator= (SignalReceiver rhs) |
| Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs. | |
| virtual | ~SignalReceiver () |
| Virtual destructor disconnects from all connected signals. | |
Additional Inherited Members | |
| Public Types inherited from InteractiveOverlay | |
| enum | AnchorPoint { BottomLeft = int(Anchor::BottomLeft) , BottomRight = int(Anchor::BottomRight) , TopLeft = int(Anchor::TopLeft) , TopRight = int(Anchor::TopRight) , Top = int(Anchor::Top) , Bottom = int(Anchor::Bottom) , Left = int(Anchor::Left) , Right = int(Anchor::Right) , Fill = int(Anchor::Fill) } |
| Anchor point of the overlay in the hosting InteractiveView. More... | |
| Public Types inherited from ViewOverlay | |
| enum class | Anchor { BottomLeft = 0 , BottomRight = 1 , TopLeft = 2 , TopRight = 3 , Top = 4 , Bottom = 5 , Left = 6 , Right = 7 , Fill = 8 } |
| Anchor point of the overlay in the parent View. More... | |
| enum class | LayoutDirection { Horizontal = 0 , Vertical = 1 } |
| Layout direction when stacking multiple ViewOverlays at the same anchor. | |
| Signals inherited from InteractiveOverlay | |
| void | anchorPointChanged (InteractiveOverlay::AnchorPoint anchorPoint) |
| Public Attributes inherited from ViewOverlay | |
| Signal | signalUpdateRequested |
| Emitted in order to notify the parent Display that it's contents have changed and need to be re-rendered. | |
| Signal | signalLayoutNeeded |
| Emitted whenever the size hints or margin have changed to notify the parent View that it needs to perform overlay layouting. | |
| 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 InteractiveOverlay | |
| void | setOverlay (GlOverlay *overlay, bool ownOverlay) |
| Update the internal GlOverlay. | |
| Protected Member Functions inherited from SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
| Protected Attributes inherited from InteractiveOverlay | |
| GlOverlay * | m_overlay = nullptr |
| Underlying GlOverlay. | |
| std::unique_ptr< OverlayInteraction > | m_interaction |
| Interaction class to handle overlay events. | |
| AnchorPoint | m_anchorPoint |
| Anchor point within parent view. | |
| bool | m_ownOverlay = true |
| Flag whether m_overlay is owned by this instance. | |
| Protected Attributes inherited from ViewOverlay | |
| std::unique_ptr< GlOverlay > | m_glOverlay |
| GL::Viewport | m_viewport = {} |
| vec2i | m_margin = vec2i::Zero() |
| bool | m_isVisible = true |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
| Properties inherited from InteractiveOverlay | |
| InteractiveOverlay::AnchorPoint | anchorPoint |
| InteractiveOrientationMeshOverlay | ( | const Mesh & | mesh, |
| InteractiveView * | view, | ||
| AnchorPoint | anchor ) |
Constructs a new InteractiveOrientationMeshOverlay with the given mesh.
The modelView matrix of view is used to determine the orientation of the mesh. This is not necessarily the anchor view, e.g. the overlay could be part of one view but display the orientation of another. The mesh is not stored and can be deleted after this call.
| void loadMesh | ( | const Mesh & | mesh | ) |
Updates the mesh of the overlay.
The mesh is not stored and can be deleted after this call.
