MeVisLabToolboxReference
SoCSOLabelRenderer Class Reference

Extension for rendering labels for CSOs. More...

#include <SoCSOLabelRenderer.h>

Inheritance diagram for SoCSOLabelRenderer:
SoCSOEditorExtension

List of all members.

Classes

struct  DeviceOffset
 Struct to hold device offsets.

Public Member Functions

 SoCSOLabelRenderer ()
 Standard constructor.
 ~SoCSOLabelRenderer ()
 Destructor.
virtual void draw (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, SoView2DCSOExtensibleEditor *editor)
 Drawing routine.
void labelStartPressAt (ml::CSO *cso, const SoPointerPosition &pos)
void labelDragMoveTo (ml::CSO *cso, const SoPointerPosition &pos)
SoPointingAction * labelEndPress (ml::CSO *cso, int clickCount)
virtual void createStartPressAt (const SoPointerPosition &)
virtual void createDragMoveTo (const SoPointerPosition &)
virtual bool createEndPress (int)
virtual void selectAndMoveStartPressAt (const SoPointerPosition &)
virtual void selectAndMoveDragMoveTo (const SoPointerPosition &)
virtual SoPointingAction * selectAndMoveEndPress (int)
virtual int cursorShape () const
 Returns the cursor shape that indicates the next creation.
virtual bool shouldRenderGeneral (ml::CSO *) const
 Returns whether a given CSO should be rendered by this general extension.
virtual void startDrawing (View2DSliceList *slicelist)
 Is called before drawing.
ml::CSOgetLabelCSO (const std::string &currentViewerId, const SoPointerPosition &pos)
 Returns the pointer to a CSO whose label is on the given viewer under the given position.
void setOuterModule (ml::CSOLabelRenderer *labelRendererModule)
 Sets a pointer to the 'outer' module.
void updateStringsInCache ()
 Updates all label strings in the cache.
virtual void resetCache ()
 Resets the internal label string cache.

Static Public Member Functions

static void initClass ()
 init class in inventor runtime

Public Attributes

SoSFInt32 labelBorderMarginX
 Sets the inner margin of the label border in x-direction.
SoSFInt32 labelBorderMarginY
 Sets the inner margin of the label border in y-direction.
SoSFBool drawLabelBorderForSelectedCSO
 Shall a border be drawn around the label of a selected CSO?
SoSFTrigger repaintTrigger
 Just a dummy field to trigger a repaint.

Detailed Description

Extension for rendering labels for CSOs.

Definition at line 39 of file SoCSOLabelRenderer.h.


Constructor & Destructor Documentation

SoCSOLabelRenderer::SoCSOLabelRenderer ( )

Standard constructor.

SoCSOLabelRenderer::~SoCSOLabelRenderer ( )

Destructor.


Member Function Documentation

virtual void SoCSOLabelRenderer::createDragMoveTo ( const SoPointerPosition &  ) [inline, virtual]

Implements SoCSOEditorExtension.

Definition at line 63 of file SoCSOLabelRenderer.h.

virtual bool SoCSOLabelRenderer::createEndPress ( int  ) [inline, virtual]

Implements SoCSOEditorExtension.

Definition at line 64 of file SoCSOLabelRenderer.h.

virtual void SoCSOLabelRenderer::createStartPressAt ( const SoPointerPosition &  ) [inline, virtual]

Implements SoCSOEditorExtension.

Definition at line 62 of file SoCSOLabelRenderer.h.

virtual int SoCSOLabelRenderer::cursorShape ( ) const [inline, virtual]

Returns the cursor shape that indicates the next creation.

Reimplemented from SoCSOEditorExtension.

Definition at line 70 of file SoCSOLabelRenderer.h.

References SoViewerProxy::DEFAULT_CURSOR.

virtual void SoCSOLabelRenderer::draw ( const CSODrawCSOInfos csoInfos,
const CSODrawView2DInfos view2DInfos,
const CSODrawSliceInformation drawSliceInfo,
SoView2DCSOExtensibleEditor editor 
) [virtual]

Drawing routine.

Reimplemented from SoCSOEditorExtension.

ml::CSO* SoCSOLabelRenderer::getLabelCSO ( const std::string &  currentViewerId,
const SoPointerPosition &  pos 
)

Returns the pointer to a CSO whose label is on the given viewer under the given position.

static void SoCSOLabelRenderer::initClass ( ) [static]

init class in inventor runtime

Reimplemented from SoCSOEditorExtension.

void SoCSOLabelRenderer::labelDragMoveTo ( ml::CSO cso,
const SoPointerPosition &  pos 
)
SoPointingAction* SoCSOLabelRenderer::labelEndPress ( ml::CSO cso,
int  clickCount 
)
void SoCSOLabelRenderer::labelStartPressAt ( ml::CSO cso,
const SoPointerPosition &  pos 
)
virtual void SoCSOLabelRenderer::resetCache ( ) [virtual]

Resets the internal label string cache.

Reimplemented from SoCSOEditorExtension.

virtual void SoCSOLabelRenderer::selectAndMoveDragMoveTo ( const SoPointerPosition &  ) [inline, virtual]

Implements SoCSOEditorExtension.

Definition at line 67 of file SoCSOLabelRenderer.h.

virtual SoPointingAction* SoCSOLabelRenderer::selectAndMoveEndPress ( int  ) [inline, virtual]

Implements SoCSOEditorExtension.

Definition at line 68 of file SoCSOLabelRenderer.h.

virtual void SoCSOLabelRenderer::selectAndMoveStartPressAt ( const SoPointerPosition &  ) [inline, virtual]

Implements SoCSOEditorExtension.

Definition at line 66 of file SoCSOLabelRenderer.h.

void SoCSOLabelRenderer::setOuterModule ( ml::CSOLabelRenderer labelRendererModule) [inline]

Sets a pointer to the 'outer' module.

Definition at line 80 of file SoCSOLabelRenderer.h.

virtual bool SoCSOLabelRenderer::shouldRenderGeneral ( ml::CSO ) const [inline, virtual]

Returns whether a given CSO should be rendered by this general extension.

Overwrite this in general renderers.

Reimplemented from SoCSOEditorExtension.

Definition at line 72 of file SoCSOLabelRenderer.h.

virtual void SoCSOLabelRenderer::startDrawing ( View2DSliceList ) [virtual]

Is called before drawing.

Reimplemented from SoCSOEditorExtension.

void SoCSOLabelRenderer::updateStringsInCache ( )

Updates all label strings in the cache.


Member Data Documentation

Shall a border be drawn around the label of a selected CSO?

Definition at line 93 of file SoCSOLabelRenderer.h.

Sets the inner margin of the label border in x-direction.

Definition at line 89 of file SoCSOLabelRenderer.h.

Sets the inner margin of the label border in y-direction.

Definition at line 91 of file SoCSOLabelRenderer.h.

Just a dummy field to trigger a repaint.

Definition at line 95 of file SoCSOLabelRenderer.h.


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