SCENE C++ API  2.0.27
Public Types | Public Member Functions | List of all members
LSView Class Reference

The general view interface which provides functionality common to all view types. More...

#include <lsview.h>

+ Inheritance diagram for LSView:

Public Types

enum  ViewType {
  VIEW_3D = 0, CORRESPONDENCE_VIEW = 1, QUICK_VIEW = 3,
  PLANAR_VIEW = 4
}
 The list of supported view types. More...
 

Public Member Functions

bool isOffscreen () const
 Determines whether the view is an offscreen view. More...
 
ViewType getViewType () const
 Gets the view type of the view. More...
 
unsigned getViewSizeX ()
 Get the size of the view in x-direction. More...
 
unsigned getViewSizeY ()
 Get the size of the view in y-direction. More...
 
ref_ptr< LSObjectgetVisualizedObject () const
 Gets the object which is being visualized by the view. More...
 
Eigen::Vector3d pickScanPoint (const Eigen::Vector2ui &viewPoint)
 Pick a scan point from the current view. More...
 

Public Attributes

Signals
LSSignal< ref_ptr< LSMouseEvent > > onMouseLeftButtonDown
 Dispatched when the left mouse button is pushed down in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseLeftButtonUp
 Dispatched when the left mouse button is released in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseLeftButtonDoubleClick
 Dispatched when the left mouse button is double-clicked in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseRightButtonDown
 Dispatched when the right mouse button is pushed down in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseRightButtonUp
 Dispatched when the right mouse button is released in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseMiddleButtonDown
 Dispatched when the middle mouse button is pushed down in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseMiddleButtonUp
 Dispatched when the middle mouse button is released in the view. More...
 
LSSignal< ref_ptr< LSMouseEvent > > onMouseMoved
 Dispatched when the mouse is moved in the view. More...
 
LSSignal< ref_ptr< LSMouseWheelEvent > > onMouseWheelMoved
 Dispatched when the mouse wheel is moved in the view. More...
 
LSSignal< ref_ptr< LSKeyEvent > > onKeyDown
 Dispatched when a keyboard key is pushed down in the view. More...
 
LSSignal< ref_ptr< LSKeyEvent > > onKeyUp
 Dispatched when a keyboard button is released in the view. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

The general view interface which provides functionality common to all view types.

Version
SCENE API Version 2.0.0.

Member Enumeration Documentation

◆ ViewType

enum ViewType

The list of supported view types.

Version
SCENE API Version 2.0.0.
Enumerator
VIEW_3D 

3D View

CORRESPONDENCE_VIEW 

Correspondence View.

QUICK_VIEW 

Quick View.

PLANAR_VIEW 

Planar View.

Member Function Documentation

◆ isOffscreen()

bool isOffscreen ( ) const

Determines whether the view is an offscreen view.

Returns
true if the view is an offscreen view, false otherwise.
Version
SCENE API Version 2.0.0.

◆ getViewType()

ViewType getViewType ( ) const

Gets the view type of the view.

Returns
The view type of the view.
Version
SCENE API Version 2.0.0.

◆ getViewSizeX()

unsigned getViewSizeX ( )

Get the size of the view in x-direction.

Returns
The size of the view in x-direction.
Version
SCENE API Version 2.0.0.

◆ getViewSizeY()

unsigned getViewSizeY ( )

Get the size of the view in y-direction.

Returns
The size of the view in y-direction.
Version
SCENE API Version 2.0.0.

◆ getVisualizedObject()

ref_ptr<LSObject> getVisualizedObject ( ) const

Gets the object which is being visualized by the view.

Returns
The object which is being visualized by the view,
Version
SCENE API Version 2.0.0.

◆ pickScanPoint()

Eigen::Vector3d pickScanPoint ( const Eigen::Vector2ui &  viewPoint)

Pick a scan point from the current view.

Note: The point position is given in global coordinates.

Parameters
viewPointThe view point at which to pick.
Returns
The point coordinates if a point could be picked, Vec3df::NIL otherwise.
Version
SCENE API Version 2.0.0.

Member Data Documentation

◆ onMouseLeftButtonDown

LSSignal<ref_ptr<LSMouseEvent> > onMouseLeftButtonDown

Dispatched when the left mouse button is pushed down in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseLeftButtonUp

LSSignal<ref_ptr<LSMouseEvent> > onMouseLeftButtonUp

Dispatched when the left mouse button is released in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseLeftButtonDoubleClick

LSSignal<ref_ptr<LSMouseEvent> > onMouseLeftButtonDoubleClick

Dispatched when the left mouse button is double-clicked in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseRightButtonDown

LSSignal<ref_ptr<LSMouseEvent> > onMouseRightButtonDown

Dispatched when the right mouse button is pushed down in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseRightButtonUp

LSSignal<ref_ptr<LSMouseEvent> > onMouseRightButtonUp

Dispatched when the right mouse button is released in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseMiddleButtonDown

LSSignal<ref_ptr<LSMouseEvent> > onMouseMiddleButtonDown

Dispatched when the middle mouse button is pushed down in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseMiddleButtonUp

LSSignal<ref_ptr<LSMouseEvent> > onMouseMiddleButtonUp

Dispatched when the middle mouse button is released in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseMoved

LSSignal<ref_ptr<LSMouseEvent> > onMouseMoved

Dispatched when the mouse is moved in the view.

Version
SCENE API Version 2.0.0.

◆ onMouseWheelMoved

LSSignal<ref_ptr<LSMouseWheelEvent> > onMouseWheelMoved

Dispatched when the mouse wheel is moved in the view.

Version
SCENE API Version 2.0.0.

◆ onKeyDown

LSSignal<ref_ptr<LSKeyEvent> > onKeyDown

Dispatched when a keyboard key is pushed down in the view.

Version
SCENE API Version 2.0.0.

◆ onKeyUp

Dispatched when a keyboard button is released in the view.

Version
SCENE API Version 2.0.0.