MeVisLab Toolbox Reference
SoViewerElement Class Reference

Element that stores a proxy object to the currently active viewer. More...

#include <SoViewerElement.h>

Inheritance diagram for SoViewerElement:

Public Member Functions

void init (SoState *state) override
 Initializes element.
 
SbBool matches (const SoElement *elt) const override
 Always returns TRUE, since this element should never be a criterion for cache invalidation.
 
SoElement * copyMatchInfo () const override
 Create and return a copy of this element.
 

Static Public Member Functions

static void set (SoState *state, SoViewerProxy *proxy)
 Sets the proxy for the currently active viewer.
 
static SoViewerProxyget (SoState *state)
 Returns the proxy for the currently active viewer (might be NULL!)
 
static void setCursor (SoState *state, int shapeID)
 Convenience method which calls the corresponding method of SoViewerProxy (or does nothing if the proxy is NULL)
 
static double getDevicePixelRatio (SoState *state)
 Convenience method which calls the corresponding method of SoViewerProxy.
 
static void setViewerProxyCB (void *userData, SoAction *action)
 this callback can be used with SoCallback nodes and simply sets the SoViewerProxy given as userData
 
static void initClass ()
 Initializes the SoViewerElement class.
 

Protected Member Functions

 ~SoViewerElement () override
 

Protected Attributes

SoViewerProxy_proxy
 Pointer to the proxy for the active viewer.
 

Detailed Description

Element that stores a proxy object to the currently active viewer.

Definition at line 28 of file SoViewerElement.h.

Constructor & Destructor Documentation

◆ ~SoViewerElement()

SoViewerElement::~SoViewerElement ( )
overrideprotected

Member Function Documentation

◆ copyMatchInfo()

SoElement * SoViewerElement::copyMatchInfo ( ) const
override

Create and return a copy of this element.

◆ get()

static SoViewerProxy * SoViewerElement::get ( SoState * state)
static

Returns the proxy for the currently active viewer (might be NULL!)

◆ init()

void SoViewerElement::init ( SoState * state)
override

Initializes element.

◆ initClass()

static void SoViewerElement::initClass ( )
static

Initializes the SoViewerElement class.

◆ matches()

SbBool SoViewerElement::matches ( const SoElement * elt) const
override

Always returns TRUE, since this element should never be a criterion for cache invalidation.

◆ set()

static void SoViewerElement::set ( SoState * state,
SoViewerProxy * proxy )
static

Sets the proxy for the currently active viewer.

◆ setCursor()

static void SoViewerElement::setCursor ( SoState * state,
int shapeID )
static

Convenience method which calls the corresponding method of SoViewerProxy (or does nothing if the proxy is NULL)

◆ setViewerProxyCB()

static void SoViewerElement::setViewerProxyCB ( void * userData,
SoAction * action )
static

this callback can be used with SoCallback nodes and simply sets the SoViewerProxy given as userData

Member Data Documentation

◆ _proxy

SoViewerProxy* SoViewerElement::_proxy
protected

Pointer to the proxy for the active viewer.

Definition at line 67 of file SoViewerElement.h.


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