LegendKit Class Reference

List of all members.

Public Member Functions
	LegendKit (void)
void	preRender (SoAction *action)
void	setImageTransparency (const float transparency=0.0f)
void	useTextureNotImage (const SbBool onoff)
void	setColorCB (uint32_t(*colorCB)(double, void *), void *userdata=NULL)
void	setColorCB (uint32_t(*colorCB)(double))
void	clearTicks (void)
void	addSmallTick (double nval)
void	addBigTick (double nval, double tickvalue, const SbString *discretestring=NULL)
void	addBigTick (double nval, const SbString &string, const SbString *discretestring=NULL)
void	clearColors (void)
void	setDiscreteMode (const SbBool onoff)
void	addDiscreteColor (double uppernval, uint32_t color)
void	addDiscreteColor (double uppernval)
void	clearData (void)
void	enableImage (const SbBool onoff)
float	getLegendWidth (void) const
void	setTickAndLinesColor (const SbColor &color, const float transparency=0.0f)
void	setTextColor (const SbColor &color, const float transparency=0.0f)
void	setPosition (const SbVec2s &pos)
void	setBackgroundColor (const SbColor &color, const float transparency=0.0f)
void	enableBackground (const SbBool onoff)
Static Public Member Functions
static void	initClass (void)
Public Attributes
SoSFBool	on
SoSFFloat	imageWidth
SoSFFloat	space
SoSFFloat	bigTickSize
SoSFFloat	smallTickSize
SoSFString	tickValueFormat
SoSFFloat	tickValueOffset
SoMFString	minvalue
SoMFString	maxvalue
SoSFBool	delayedRender
SoSFFloat	topSpace
SoSFBool	discreteUseLower
SoSFBool	threadSafe
SbVec2s	size
bool	istop
bool	isleft
float	lenmin
Protected Member Functions
virtual void	GLRender (SoGLRenderAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	search (SoSearchAction *action)
virtual void	callback (SoCallbackAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	pick (SoPickAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	audioRender (SoAudioRenderAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual SbBool	affectsState (void) const
virtual	~LegendKit ()
virtual void	notify (SoNotList *list)
virtual void	setDefaultOnNonWritingFields ()
Private Types
typedef SoBaseKit	inherited
Private Member Functions
	SO_KIT_HEADER (LegendKit)
	SO_KIT_CATALOG_ENTRY_HEADER (topSeparator)
	SO_KIT_CATALOG_ENTRY_HEADER (viewport)
	SO_KIT_CATALOG_ENTRY_HEADER (resetTransform)
	SO_KIT_CATALOG_ENTRY_HEADER (position)
	SO_KIT_CATALOG_ENTRY_HEADER (depthBuffer)
	SO_KIT_CATALOG_ENTRY_HEADER (lightModel)
	SO_KIT_CATALOG_ENTRY_HEADER (camera)
	SO_KIT_CATALOG_ENTRY_HEADER (texture)
	SO_KIT_CATALOG_ENTRY_HEADER (shapeHints)
	SO_KIT_CATALOG_ENTRY_HEADER (pickStyle)
	SO_KIT_CATALOG_ENTRY_HEADER (backgroundMaterial)
	SO_KIT_CATALOG_ENTRY_HEADER (backgroundShape)
	SO_KIT_CATALOG_ENTRY_HEADER (imageSeparator)
	SO_KIT_CATALOG_ENTRY_HEADER (imageTransform)
	SO_KIT_CATALOG_ENTRY_HEADER (imageMaterial)
	SO_KIT_CATALOG_ENTRY_HEADER (imageSwitch)
	SO_KIT_CATALOG_ENTRY_HEADER (imageGroup)
	SO_KIT_CATALOG_ENTRY_HEADER (imageTranslation)
	SO_KIT_CATALOG_ENTRY_HEADER (image)
	SO_KIT_CATALOG_ENTRY_HEADER (textureGroup)
	SO_KIT_CATALOG_ENTRY_HEADER (textureQuality)
	SO_KIT_CATALOG_ENTRY_HEADER (textureImage)
	SO_KIT_CATALOG_ENTRY_HEADER (textureShape)
	SO_KIT_CATALOG_ENTRY_HEADER (tickMaterial)
	SO_KIT_CATALOG_ENTRY_HEADER (renderCallbackLines)
	SO_KIT_CATALOG_ENTRY_HEADER (textMaterial)
	SO_KIT_CATALOG_ENTRY_HEADER (renderCallbackText)
	SO_KIT_CATALOG_ENTRY_HEADER (extraNodes)
void	recalcSize (SoState *state)
void	initBackground (const SbBool force=FALSE)
void	initTextureImage (void)
void	initImage (void)
void	reallyInitImage (unsigned char *data, unsigned char *rowdata=NULL)
void	fillImageAlpha (void)
void	render (SoGLRenderAction *action, const SbBool lines)
void	renderLines (SoGLRenderAction *action)
void	renderText (SoGLRenderAction *action)
void	renderString (const char *str, int xpos, int ypos)
void	setSwitchValue (const char *part, const int value)
Static Private Member Functions
static void	renderCBlines (void *userdata, SoAction *action)
static void	renderCBtext (void *userdata, SoAction *action)
Private Attributes
class LegendKitP *	pimpl
Friends
class	LegendKitP

---

Member Typedef Documentation

typedef SoBaseKit LegendKit::inherited [private]

---

Constructor & Destructor Documentation

LegendKit::LegendKit

(

void

)

virtual LegendKit::~LegendKit

(

)

[protected, virtual]

---

Member Function Documentation

void LegendKit::addBigTick	(	double	nval,
		double	tickvalue,
		const SbString *	discretestring = NULL
	)

void LegendKit::addBigTick	(	double	nval,
		const SbString &	string,
		const SbString *	discretestring = NULL
	)

void LegendKit::addDiscreteColor	(	double	uppernval,
		uint32_t	color
	)

void LegendKit::addDiscreteColor

(

double

uppernval

)

void LegendKit::addSmallTick

(

double

nval

)

virtual SbBool LegendKit::affectsState

(

void

)

const [protected, virtual]

virtual void LegendKit::audioRender

(

SoAudioRenderAction *

action

)

[protected, virtual]

virtual void LegendKit::callback

(

SoCallbackAction *

action

)

[protected, virtual]

void LegendKit::clearColors

(

void

)

void LegendKit::clearData

(

void

)

void LegendKit::clearTicks

(

void

)

void LegendKit::enableBackground

(

const SbBool

onoff

)

void LegendKit::enableImage

(

const SbBool

onoff

)

void LegendKit::fillImageAlpha

(

void

)

[private]

virtual void LegendKit::getBoundingBox

(

SoGetBoundingBoxAction *

action

)

[protected, virtual]

float LegendKit::getLegendWidth

(

void

)

const

virtual void LegendKit::getMatrix

(

SoGetMatrixAction *

action

)

[protected, virtual]

virtual void LegendKit::getPrimitiveCount

(

SoGetPrimitiveCountAction *

action

)

[protected, virtual]

virtual void LegendKit::GLRender

(

SoGLRenderAction *

action

)

[protected, virtual]

virtual void LegendKit::handleEvent

(

SoHandleEventAction *

action

)

[protected, virtual]

void LegendKit::initBackground

(

const SbBool

force = FALSE

)

[private]

static void LegendKit::initClass

(

void

)

[static]

void LegendKit::initImage

(

void

)

[private]

void LegendKit::initTextureImage

(

void

)

[private]

virtual void LegendKit::notify

(

SoNotList *

list

)

[protected, virtual]

virtual void LegendKit::pick

(

SoPickAction *

action

)

[protected, virtual]

void LegendKit::preRender

(

SoAction *

action

)

virtual void LegendKit::rayPick

(

SoRayPickAction *

action

)

[protected, virtual]

void LegendKit::reallyInitImage	(	unsigned char *	data,
		unsigned char *	rowdata = NULL
	)			[private]

void LegendKit::recalcSize

(

SoState *

state

)

[private]

void LegendKit::render	(	SoGLRenderAction *	action,
		const SbBool	lines
	)			[private]

static void LegendKit::renderCBlines	(	void *	userdata,
		SoAction *	action
	)			[static, private]

static void LegendKit::renderCBtext	(	void *	userdata,
		SoAction *	action
	)			[static, private]

void LegendKit::renderLines

(

SoGLRenderAction *

action

)

[private]

void LegendKit::renderString	(	const char *	str,
		int	xpos,
		int	ypos
	)			[private]

void LegendKit::renderText

(

SoGLRenderAction *

action

)

[private]

virtual void LegendKit::search

(

SoSearchAction *

action

)

[protected, virtual]

void LegendKit::setBackgroundColor	(	const SbColor &	color,
		const float	transparency = 0.0f
	)

void LegendKit::setColorCB	(	uint32_t(*)(double, void *)	colorCB,
		void *	userdata = NULL
	)

void LegendKit::setColorCB

(

uint32_t(*)(double)

colorCB

)

virtual void LegendKit::setDefaultOnNonWritingFields

(

)

[protected, virtual]

void LegendKit::setDiscreteMode

(

const SbBool

onoff

)

void LegendKit::setImageTransparency

(

const float

transparency = 0.0f

)

void LegendKit::setPosition

(

const SbVec2s &

pos

)

void LegendKit::setSwitchValue	(	const char *	part,
		const int	value
	)			[private]

void LegendKit::setTextColor	(	const SbColor &	color,
		const float	transparency = 0.0f
	)

void LegendKit::setTickAndLinesColor	(	const SbColor &	color,
		const float	transparency = 0.0f
	)

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

lightModel

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

imageGroup

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

textMaterial

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

topSeparator

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

backgroundShape

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

viewport

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

camera

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

depthBuffer

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

imageSwitch

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

renderCallbackText

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

imageMaterial

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

tickMaterial

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

pickStyle

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

backgroundMaterial

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

imageTranslation

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

imageTransform

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

shapeHints

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

renderCallbackLines

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

textureGroup

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

textureImage

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

texture

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

position

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

imageSeparator

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

textureQuality

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

resetTransform

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

textureShape

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

image

)

[private]

LegendKit::SO_KIT_CATALOG_ENTRY_HEADER

(

extraNodes

)

[private]

LegendKit::SO_KIT_HEADER

(

LegendKit

)

[private]

void LegendKit::useTextureNotImage

(

const SbBool

onoff

)

---

Friends And Related Function Documentation

friend class LegendKitP [friend]

---

Member Data Documentation

SoSFFloat LegendKit::bigTickSize

SoSFBool LegendKit::delayedRender

SoSFBool LegendKit::discreteUseLower

SoSFFloat LegendKit::imageWidth

bool LegendKit::isleft

bool LegendKit::istop

float LegendKit::lenmin

SoMFString LegendKit::maxvalue

SoMFString LegendKit::minvalue

SoSFBool LegendKit::on

class LegendKitP* LegendKit::pimpl [private]

SbVec2s LegendKit::size

SoSFFloat LegendKit::smallTickSize

SoSFFloat LegendKit::space

SoSFBool LegendKit::threadSafe

SoSFString LegendKit::tickValueFormat

SoSFFloat LegendKit::tickValueOffset

SoSFFloat LegendKit::topSpace