SoView2DOverlayDecoration Class Reference

Draws an overlay image on the SoView2D. More...

#include <SoView2DOverlayDecoration.h>

Inheritance diagram for SoView2DOverlayDecoration:

List of all members.

Public Types
enum	Position { TOP, BOTTOM, LEFT, RIGHT }
Public Member Functions
	SoView2DOverlayDecoration ()
	Constructor.
virtual void	draw (View2DSliceList *dsl, View2DSlice *dslice, int slice)
	reimplemented from SoView2DExtension
Static Public Member Functions
static void	initClass ()
	inventor runtime type system
Public Attributes
SoSFMLImage	image
	input image
SoSFFloat	magnifyFactor
	set the magnifyFactor that is used for the ruler
SoSFBool	border
SoSFColor	borderColor
SoSFFloat	borderBlend
SoSFBool	leftRuler
SoSFBool	rightRuler
SoSFBool	topRuler
SoSFBool	bottomRuler
SoSFColor	rulerColor
SoSFBool	rulerShadow
SoSFColor	rulerShadowColor
SoSFFloat	rulerBlend
SoSFFloat	rulerMarkLength
SoSFFloat	rulerLongMarkLength
Protected Member Functions
bool	isImageParallel (View2DSliceList *dsl)
	Return true if overlay is parallel to image up to slice thickness.
void	drawRuler (float mmToPixel, float x1, float y1, float x2, float y2, SoView2DOverlayDecoration::Position pos)
	draw a ruler at the given position
virtual	~SoView2DOverlayDecoration ()
	Destructor.

---

Detailed Description

Draws an overlay image on the SoView2D.

SoView2DOverlayDecoration is derived from SoView2DCallback to allow others to register with the callback

Author:

Florian Link

Definition at line 36 of file SoView2DOverlayDecoration.h.

---

Member Enumeration Documentation

enum SoView2DOverlayDecoration::Position

Enumerator:

TOP
BOTTOM
LEFT
RIGHT

Definition at line 65 of file SoView2DOverlayDecoration.h.

---

Constructor & Destructor Documentation

SoView2DOverlayDecoration::SoView2DOverlayDecoration

(

)

Constructor.

virtual SoView2DOverlayDecoration::~SoView2DOverlayDecoration

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

virtual void SoView2DOverlayDecoration::draw	(	View2DSliceList *	dsl,
		View2DSlice *	dslice,
		int	slice
	)			[virtual]

reimplemented from SoView2DExtension

Reimplemented from SoView2DCallback.

void SoView2DOverlayDecoration::drawRuler	(	float	mmToPixel,
		float	x1,
		float	y1,
		float	x2,
		float	y2,
		SoView2DOverlayDecoration::Position	pos
	)			[protected]

draw a ruler at the given position

static void SoView2DOverlayDecoration::initClass

(

)

[static]

inventor runtime type system

Reimplemented from SoView2DCallback.

bool SoView2DOverlayDecoration::isImageParallel

(

View2DSliceList *

dsl

)

[protected]

Return true if overlay is parallel to image up to slice thickness.

---

Member Data Documentation

SoSFBool SoView2DOverlayDecoration::border

Definition at line 49 of file SoView2DOverlayDecoration.h.

SoSFFloat SoView2DOverlayDecoration::borderBlend

Definition at line 51 of file SoView2DOverlayDecoration.h.

SoSFColor SoView2DOverlayDecoration::borderColor

Definition at line 50 of file SoView2DOverlayDecoration.h.

SoSFBool SoView2DOverlayDecoration::bottomRuler

Definition at line 55 of file SoView2DOverlayDecoration.h.

SoSFMLImage SoView2DOverlayDecoration::image

input image

Definition at line 44 of file SoView2DOverlayDecoration.h.

SoSFBool SoView2DOverlayDecoration::leftRuler

Definition at line 52 of file SoView2DOverlayDecoration.h.

SoSFFloat SoView2DOverlayDecoration::magnifyFactor

set the magnifyFactor that is used for the ruler

Definition at line 47 of file SoView2DOverlayDecoration.h.

SoSFBool SoView2DOverlayDecoration::rightRuler

Definition at line 53 of file SoView2DOverlayDecoration.h.

SoSFFloat SoView2DOverlayDecoration::rulerBlend

Definition at line 59 of file SoView2DOverlayDecoration.h.

SoSFColor SoView2DOverlayDecoration::rulerColor

Definition at line 56 of file SoView2DOverlayDecoration.h.

SoSFFloat SoView2DOverlayDecoration::rulerLongMarkLength

Definition at line 61 of file SoView2DOverlayDecoration.h.

SoSFFloat SoView2DOverlayDecoration::rulerMarkLength

Definition at line 60 of file SoView2DOverlayDecoration.h.

SoSFBool SoView2DOverlayDecoration::rulerShadow

Definition at line 57 of file SoView2DOverlayDecoration.h.

SoSFColor SoView2DOverlayDecoration::rulerShadowColor

Definition at line 58 of file SoView2DOverlayDecoration.h.

SoSFBool SoView2DOverlayDecoration::topRuler

Definition at line 54 of file SoView2DOverlayDecoration.h.

---

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

• MeVisLab/Standard/Sources/Inventor/SoView2D/extensions/SoView2DOverlayDecoration.h