MeVisLab Resolution Independence API
SoOffscreenViewerProxy Class Reference

This class implements access to the state of the SoOffscreenRenderer viewer. More...

#include <SoOffscreenViewerProxy.h>

Inheritance diagram for SoOffscreenViewerProxy:
SoResolutionIndependentViewerProxy SoViewerProxy

Public Member Functions

 SoOffscreenViewerProxy (ml::OffscreenRenderer *offscreenRenderer=nullptr)
 Constructor. More...
 
 ~SoOffscreenViewerProxy () override
 Destructor. More...
 
bool isHighQualityOffscreenRendering () const override
 returns true if high quality offscreen rendering (e.g. for OffscreenRenderer) is desired More...
 
- Public Member Functions inherited from SoResolutionIndependentViewerProxy
 SoResolutionIndependentViewerProxy ()
 Constructor. More...
 
 ~SoResolutionIndependentViewerProxy () override
 Destructor. More...
 
double getDevicePixelRatio () override
 Returns the ratio between physical pixels and device-independent pixels for the viewer. More...
 
void setDevicePixelRatio (double scaleFactor)
 
- Public Member Functions inherited from SoViewerProxy
virtual ~SoViewerProxy ()
 Destructor. More...
 
virtual void setCursor (int)
 Set cursor of viewer to pre- or user-defined shape, invalid values will set cursor to default shape. More...
 
virtual bool hasShape (int shapeID)
 return true if the cursor shape has already been defined More...
 
virtual int defineCursor (const char *, int=-1, int=-1, int=-1)
 Define new cursor shape - successful operation is only guaranteed with PNG-Images with size 32x32, containing only black, white and transparent pixels. More...
 
virtual bool getCurrentCursorPosition (int &x, int &y)
 Get current cursor position relative to the viewing window. More...
 
virtual bool isInitialRendering () const
 returns true if the viewer does the initial rendering after it became visible More...
 
virtual bool isUserInterationEventInQueue () const
 returns if a user interaction event is the the GUI event queue (or in a remote rendering scenario in the incoming message queue). More...
 
virtual SoMetaInformationMapgetMetaInformationMap ()
 returns the current SoMetaInformationMap, which allows storing of the current meta information / render state as key/value pairs. More...
 
virtual void setForceCursor (int shapeID)
 Enforce setting the cursor, even from mouseOverUpdates. More...
 

Protected Attributes

ml::OffscreenRenderer_offscreenRenderer
 Pointer to the actual viewer. More...
 
- Protected Attributes inherited from SoResolutionIndependentViewerProxy
double _devicePixelRatio
 device pixel ratio More...
 

Additional Inherited Members

- Public Types inherited from SoViewerProxy
enum  cursorShapeEnum {
  UNDEFINED_CURSOR = -1 , DEFAULT_CURSOR = 0 , FORBIDDEN_CURSOR , POINTING_HAND_CURSOR ,
  OPEN_HAND_CURSOR , CLOSED_HAND_CURSOR , MOVE_ALL_CURSOR , MOVE_HORI_CURSOR ,
  MOVE_VERT_CURSOR , MOVE_FDIAG_CURSOR , MOVE_BDIAG_CURSOR , MOVE_INOUT_CURSOR ,
  ROTATE_X_CURSOR , ROTATE_Y_CURSOR , ROTATE_Z_CURSOR , ROTATE_XY_CURSOR ,
  ZOOM_CURSOR , ZOOM_IN_CURSOR , ZOOM_OUT_CURSOR , CROSS_CURSOR ,
  CROSS_PLUS_CURSOR , CROSS_MINUS_CURSOR , CROSS_MOVE_CURSOR , CROSS_ROTATE_CURSOR ,
  CROSS_RECT_CURSOR , CROSS_OVAL_CURSOR , CROSS_VECTOR_CURSOR , CROSS_FREEFORM_CURSOR ,
  CROSS_POINT_CURSOR , CROSS_LINE_CURSOR , CROSS_CURVE_CURSOR , CROSS_POLYLINE_CURSOR ,
  CROSS_POLYGON_CURSOR , CROSS_FILL_CURSOR , CROSS_LINK_CURSOR , CROSS_0_CURSOR ,
  CROSS_1_CURSOR , CROSS_2_CURSOR , CROSS_3_CURSOR , CROSS_4_CURSOR ,
  CROSS_5_CURSOR , CROSS_6_CURSOR , CROSS_7_CURSOR , CROSS_8_CURSOR ,
  CROSS_9_CURSOR , LUT_CURSOR , LUT_1_CURSOR , LUT_2_CURSOR ,
  LUT_3_CURSOR , SLICING_CURSOR , BLANK_CURSOR , OTHER_CURSOR_0 ,
  OTHER_CURSOR_1 , OTHER_CURSOR_2 , OTHER_CURSOR_3 , OTHER_CURSOR_4 ,
  OTHER_CURSOR_5 , OTHER_CURSOR_6 , OTHER_CURSOR_7 , OTHER_CURSOR_8 ,
  OTHER_CURSOR_9 , OTHER_CURSOR_10 , OTHER_CURSOR_11 , OTHER_CURSOR_12 ,
  OTHER_CURSOR_13 , OTHER_CURSOR_14 , OTHER_CURSOR_15 , OTHER_CURSOR_16 ,
  OTHER_CURSOR_17 , OTHER_CURSOR_18 , OTHER_CURSOR_19 , OTHER_CURSOR_20 ,
  OTHER_CURSOR_21 , OTHER_CURSOR_22 , OTHER_CURSOR_23 , OTHER_CURSOR_24 ,
  OTHER_CURSOR_25 , OTHER_CURSOR_26 , OTHER_CURSOR_27 , OTHER_CURSOR_28 ,
  OTHER_CURSOR_29 , OTHER_CURSOR_30 , OTHER_CURSOR_31 , OTHER_CURSOR_32 ,
  OTHER_CURSOR_33 , OTHER_CURSOR_34 , OTHER_CURSOR_35 , OTHER_CURSOR_36 ,
  OTHER_CURSOR_37 , OTHER_CURSOR_38 , OTHER_CURSOR_39 , OTHER_CURSOR_40 ,
  OTHER_CURSOR_41 , OTHER_CURSOR_42 , OTHER_CURSOR_43 , OTHER_CURSOR_44 ,
  OTHER_CURSOR_45 , OTHER_CURSOR_46 , OTHER_CURSOR_47 , OTHER_CURSOR_48 ,
  OTHER_CURSOR_49 , OTHER_CURSOR_50 , OTHER_CURSOR_51 , OTHER_CURSOR_52 ,
  OTHER_CURSOR_53 , OTHER_CURSOR_54 , OTHER_CURSOR_55 , OTHER_CURSOR_56 ,
  OTHER_CURSOR_57 , OTHER_CURSOR_58 , OTHER_CURSOR_59 , OTHER_CURSOR_60 ,
  OTHER_CURSOR_61 , OTHER_CURSOR_62 , OTHER_CURSOR_63 , OTHER_CURSOR_64 ,
  OTHER_CURSOR_65 , OTHER_CURSOR_66 , OTHER_CURSOR_67 , OTHER_CURSOR_68 ,
  OTHER_CURSOR_69 , PREDEFINED_CURSOR_COUNT
}
 pre-defined cursor shapes; note that you must adapt the list of names in SoViewerProxy.cpp if you change this list More...
 
- Static Public Member Functions inherited from SoViewerProxy
static const char *const * cursorShapeNames ()
 return list of strings containing cursor shape names; this includes UNDEFINED_CURSOR, so you must add 1 when indexing this array More...
 
static int getPredefinedCursorCount ()
 get number of predefined cursors from code (instead of requiring a re-compilation of all using libraries when using the value PREDEFINED_CURSOR_COUNT) More...
 
static const ml::EnumValues< cursorShapeEnum > & getCursorShapeEnumValues ()
 get enum values record for use with ml::TypedEnumField More...
 
static int getNextFreeShapeID ()
 return the next free id for defining your own cursor shape More...
 
- Protected Member Functions inherited from SoViewerProxy
 SoViewerProxy ()
 Protected constructor. Class must be derived to be adapted to actual viewer. More...
 

Detailed Description

This class implements access to the state of the SoOffscreenRenderer viewer.

Definition at line 28 of file SoOffscreenViewerProxy.h.

Constructor & Destructor Documentation

◆ SoOffscreenViewerProxy()

SoOffscreenViewerProxy::SoOffscreenViewerProxy ( ml::OffscreenRenderer offscreenRenderer = nullptr)

Constructor.

◆ ~SoOffscreenViewerProxy()

SoOffscreenViewerProxy::~SoOffscreenViewerProxy ( )
inlineoverride

Destructor.

Definition at line 34 of file SoOffscreenViewerProxy.h.

Member Function Documentation

◆ isHighQualityOffscreenRendering()

bool SoOffscreenViewerProxy::isHighQualityOffscreenRendering ( ) const
inlineoverridevirtual

returns true if high quality offscreen rendering (e.g. for OffscreenRenderer) is desired

Reimplemented from SoViewerProxy.

Definition at line 36 of file SoOffscreenViewerProxy.h.

Member Data Documentation

◆ _offscreenRenderer

ml::OffscreenRenderer* SoOffscreenViewerProxy::_offscreenRenderer
protected

Pointer to the actual viewer.

Definition at line 40 of file SoOffscreenViewerProxy.h.


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