Graphic class. More...

#include <ilviews/graphics/gauge.h>

Inheritance diagram for IlvGauge:

Public Member Functions
	IlvGauge (IlvDisplay display, const IlvRect &drawrect, IlFloat min=0, IlFloat max=100, IlFloat value=50, IlvPalette palette=0)
	Constructor. More...

virtual void	applyTransform (const IlvTransformer *t)
	Applies a transformation function to the graphic object. More...

virtual void	bboxRange (IlFloat v1, IlFloat v2, IlvRect &rect, const IlvTransformer *t=0) const =0
	Returns the rectangle to update when the value of the gauge changes. More...

virtual void	boundingBox (IlvRect &, const IlvTransformer *t=0) const =0
	Retrieves the bounding box of the graphic object. More...

virtual void	draw (IlvPort , const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphic object. More...

virtual void	drawFocus (IlvPort , const IlvPalette , const IlvTransformer t=0, const IlvRegion clip=0) const
	Draws additional drawings for an object that has the keyboard focus. More...

virtual void	drawValue (IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const =0
	Performs the drawing representing the current value of the gauge. More...

virtual const char *	getDefaultInteractor () const
	Gets the name of the default interactor for this object. More...

IlFloat	getMax () const
	Returns the maximum value of the gauge. More...

IlFloat	getMin () const
	Returns the minimum value of the gauge. More...

IlFloat	getValue () const
	Returns the current value of the gauge. More...

virtual void	invert (IlBoolean=IlFalse)
	Highlights the object. More...

virtual IlFloat	requestValue (const IlvPoint &point, const IlvTransformer *t, IlBoolean &connect) const =0
	Returns the value of the gauge associated with a given point. More...

virtual void	setAlpha (IlvIntensity alpha)
	Sets the alpha value of the object. More...

virtual void	setAntialiasingMode (IlvAntialiasingMode mode)
	Sets the anti-aliasing mode of the object. More...

virtual void	setBackground (IlvColor *)
	Sets the background color of the object. More...

virtual void	setForeground (IlvColor *)
	Sets the foreground color of the object. More...

void	setMax (IlFloat max)
	Sets the maximum value of the gauge. More...

void	setMin (IlFloat min)
	Sets the minimum value of the gauge. More...

virtual void	setMode (IlvDrawMode)
	Sets the drawing mode of the object temporarily. More...

virtual void	setOverwrite (IlBoolean value)
	Sets an overwrite mode that modifies how the drawing member functions operate. More...

virtual void	setPalette (IlvPalette *)
	Sets the internal palette. More...

virtual void	setValue (IlFloat value)
	Sets the current value of the gauge. More...

Public Member Functions inherited from IlvSimpleGraphic
	IlvSimpleGraphic (IlvDisplay display, IlvPalette palette=0)
	Initializes a new `IlvSimpleGraphic`. More...

virtual	~IlvSimpleGraphic ()
	Destructor. More...

virtual void	applyResources (const char , const char , const char , const char , IlvDisplay *=0)
	Applies resources on a graphic object. More...

IlvIntensity	getAlpha () const
	Retrieves the alpha value. More...

IlvAntialiasingMode	getAntialiasingMode () const
	Retrieves the anti-aliasing mode. More...

IlvArcMode	getArcMode () const
	Retrieves the arc mode. More...

IlvColor *	getBackground () const
	Retrieves the background color. More...

IlvColorPattern *	getColorPattern () const
	Retrieves the color pattern. More...

virtual IlvDisplay *	getDisplay () const
	Retrieves the `IlvDisplay` instance. More...

IlvFillRule	getFillRule () const
	Retrieves the fill rule. More...

IlvFillStyle	getFillStyle () const
	Retrieves the fill style. More...

IlvFont *	getFont () const
	Retrieves the font. More...

IlvColor *	getForeground () const
	Retrieves the foreground color. More...

IlvGradientPattern *	getGradientPattern () const
	Retrieves the gradient pattern. More...

IlvLineStyle *	getLineStyle () const
	Retrieves the line style. More...

IlUShort	getLineWidth () const
	Retrieves the line width. More...

virtual IlvLookFeelHandler *	getLookFeelHandler () const
	Returns the look & feel handler used by this object. More...

virtual int	getLookupStringInputMethod (IlvEvent &event, char bufferReturn, int bytesBuffer, int statusReturn)
	Gets the preedit string from an input method. More...

IlvDrawMode	getMode () const
	Retrieves the draw mode. More...

IlBoolean	getOverwrite () const
	Retrieves the overwrite mode. More...

IlvPalette *	getPalette () const
	Retrieves the internal palette value. More...

IlvPattern *	getPattern () const
	Retrieves the pattern. More...

virtual void	registerInputMethod () const
	Controls the connection of a graphic object to an input method. More...

virtual void	setArcMode (IlvArcMode)
	Sets the arc mode of the object. More...

virtual void	setColorPattern (IlvColorPattern *)
	Sets the color pattern of the object. More...

virtual void	setFillRule (IlvFillRule)
	Sets the fill rule of the object. More...

virtual void	setFillStyle (IlvFillStyle)
	Sets the fill style of the object. More...

virtual void	setFocusValuesInputMethod (IlUShort count, const IlvImValue *values) const
	Controls the interaction between a simple graphic object and an input method. More...

virtual void	setFont (IlvFont *)
	Sets the font of the object. More...

virtual void	setGradientPattern (IlvGradientPattern *)
	Sets the gradient pattern of the object. More...

virtual void	setHolder (IlvGraphicHolder *)
	Sets the object's holder. More...

virtual void	setLineStyle (IlvLineStyle *)
	Sets the line style of the object. More...

virtual void	setLineWidth (IlUShort)
	Sets the line width of the object. More...

virtual void	setPattern (IlvPattern *)
	Sets the pattern of the object. More...

virtual void	setValuesInputMethod (IlUShort count, const IlvImValue *values) const
	Controls the interaction between a graphic object and an input method. More...

virtual void	unRegisterInputMethod () const
	Controls the disconnection of a graphic object from an input method. More...

virtual void	unsetFocusInputMethod () const
	Controls the interaction between a graphic object and an input method. More...

Public Member Functions inherited from IlvGraphic
void	addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Adds a callback function to a callback list. More...

void	addCallback (const IlSymbol callbackType, const IlSymbol callbackName, const IlSymbol *script=0)
	Adds a callback function to a callback list. More...

void	addCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
	Adds a callback function to a callback list. More...

void	addClassProperty (const IlSymbol *key, IlAny value)
	Adds a property to this object's class. More...

void	addProperty (const IlSymbol *key, IlAny value)
	Adds a specific property to the object. More...

void	addTag (const IlSymbol *tag)
	Adds a tag. More...

virtual void	apply (IlvApplyObject function, IlAny arg)
	Applies a function to objects that compose another object. More...

IlBoolean	applyAttribute (const char *attributeClassName, IlInt value, IlAny checkData=0) const
	Applies attributes. More...

IlBoolean	applyAttribute (const char *attributeClassName, IlFloat value, IlAny checkData=0) const
	Applies attributes. More...

IlBoolean	applyAttribute (const char attributeClassName, const char value, IlAny checkData=0) const
	Applies attributes. More...

virtual void	applyReferences (IlvApplyObject function, IlAny arg)
	Applies a function to objects that are referenced by another object. More...

virtual void	callCallbacks (const IlSymbol *callbackType)
	Calls every callback of a given type. More...

const char *	className () const
	Returns the class name of an object. More...

virtual void	computeFocusRegion (IlvRegion &r, const IlvTransformer *t=0) const
	Computes the region needed for the drawing of the focus. More...

virtual IlBoolean	contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
	Checks whether a point is in the object. More...

IlBoolean	contains (const IlvPoint &p) const
	Checks whether a point is in the object. More...

virtual IlvGraphic *	copy () const =0
	Copies this object. More...

void	draw (IlvPort dst, const IlvTransformer t, const IlvRect *clip) const
	Draws a graphic object. More...

virtual void	getAccessors (const IlSymbol const , const IlvValueTypeClass const **, IlUInt &) const
	Retrieves the list of available accessors of an object. More...

IlvGraphicCallback	getCallback (const IlSymbol *callbackType) const
	Gets a callback. More...

IlvGraphicCallback	getCallback () const
	Gets the main callback function. More...

IlAny	getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Gets a callback user data. More...

IlAny	getCallbackData (const IlSymbol callbackType, const IlSymbol callbackName) const
	Gets a callback user data. More...

IlSymbol *	getCallbackName (const IlSymbol *callbackType) const
	Gets the name of a callback. More...

IlSymbol *	getCallbackName () const
	Gets the symbol that identifies the main callback. More...

virtual IlUInt	getCallbackTypes (const char const names, const IlSymbol const **types) const
	Gets the number of register callback types for the object. More...

virtual IlvGraphic *	getChildAt (IlUInt index) const
	Returns the sub-object of the graphic object specified by index. More...

virtual IlvGraphic *	getChildByName (const char *name) const
	Returns the sub-object of the graphic object specified by a name. More...

virtual IlUInt	getChildCount () const
	Returns the number of children of this graphic object. More...

virtual IlInt	getChildIndex (const IlvGraphic *object) const
	Returns the index of the specified sub-object in this graphic object. More...

virtual IlvGraphic const	getChildren (IlUInt &count) const
	Returns an array containing the sub-objects of this graphic object. More...

virtual IlvClassInfo *	getClassInfo () const
	Gets class information. More...

IlAny	getClassProperty (const IlSymbol *key, IlBoolean checkParent=IlFalse) const
	Retrieves the indicated property value in the class of this object. More...

IlAny	getClientData () const
	Gets client data. More...

virtual IlvGraphicHolder *	getHolder () const
	Gets a pointer to an object's holder. More...

IlvInteractor *	getInteractor () const
	Returns the interactor associated with the current object. More...

const char *	getName () const
	Gets the name of the object. More...

IlvNamedProperty *	getNamedProperty (const IlSymbol *name) const
	Gets a named property. More...

IlSymbol *	getNextFocusGraphic () const
	Gets the next object in the focus chain. More...

IlSymbol *	getPreviousFocusGraphic () const
	Gets the previous object in the focus chain. More...

IlAny	getProperty (const IlSymbol *key) const
	Gets a property. More...

IlvSmartSet *	getSmartSet () const
	Gets the smart set object containing this graphic object. More...

const IlSymbol const	getTags (IlUInt &count) const
	Returns all the tags applied to this object. More...

IlvDim	h () const
	Gets the height value of the object. More...

void	h (IlvDim h)
	Sets the height value of the object. More...

IlBoolean	hasCallback (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function is in a callback list. More...

IlBoolean	hasCallback (const IlSymbol callbackType, const IlSymbol callbackName) const
	Checks whether a callback function is in a callback list. More...

IlBoolean	hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
	Checks whether a callback function has user data. More...

IlBoolean	hasCallbackData (const IlSymbol callbackType, const IlSymbol callbackName) const
	Checks whether a callback function has user data. More...

const IlvClassInfo *	hasClassProperty (const IlSymbol *key, IlBoolean s=IlFalse) const
	Checks for a class where the keyed property exists. More...

IlBoolean	hasProperty (const IlSymbol *key) const
	Checks whether the object has a particular property. More...

IlBoolean	hasTag (const IlSymbol *tag) const
	Checks whether the object has a specific tag. More...

virtual IlBoolean	inside (const IlvRegion &r, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box. More...

IlBoolean	inside (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
	Determines whether an object with transformation applied is inside the bounding box. More...

IlBoolean	inside (const IlvRect &r) const
	Determines whether a rectangle is inside the bounding box. More...

virtual IlBoolean	intersects (const IlvRegion &r, const IlvTransformer *t=0) const
	Checks whether a region intersects the bounding box with transformation applied. More...

IlBoolean	intersects (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
	Checks whether a rectangle intersects the bounding box with transformation applied. More...

IlBoolean	intersects (const IlvRect &r) const
	Checks whether a rectangle intersects the bounding box. More...

IlBoolean	isFirstFocusGraphic () const
	Checks whether the object is first in the focus chain. More...

IlBoolean	isFocusable () const
	Checks whether the object can receive the keyboard focus. More...

IlBoolean	isInSmartSet () const
	Checks whether a graphic object belongs to a smart set. More...

IlBoolean	isLastFocusGraphic () const
	Checks whether the object is last in the focus chain. More...

IlBoolean	isSensitive () const
	Checks whether the object is sensitive. More...

IlBoolean	isSubtypeOf (const char *parentClass) const
	Checks whether this object's class is a subclass of a given parent class. More...

IlBoolean	isSubtypeOf (const IlvClassInfo *classInfo) const
	Checks whether this object's class is a subclass. More...

virtual void	move (IlvPos x, IlvPos y)
	Moves the graphic object. More...

void	move (const IlvPoint &p)
	Moves the graphic object. More...

void	moveResize (const IlvRect &size)
	Moves and resizes a graphic object. More...

virtual IlBoolean	needsInputContext () const
	Indicates whether the graphic instance can connect to an input method for locale dependent input. More...

virtual void	print (std::ostream &out, int level=0) const
	Prints for debugging purposes. More...

void	removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Removes a callback function from a callback list. More...

void	removeCallback (const IlSymbol callbackType, const IlSymbol callbackName)
	Removes a callback function from a callback list. More...

IlBoolean	removeClassProperty (const IlSymbol *key)
	Removes a property from this object's class. More...

void	removeInteractor ()
	Removes the interactor from the current object. More...

IlvNamedProperty *	removeNamedProperty (IlSymbol *name)
	Removes a named property from the object. More...

IlBoolean	removeProperty (const IlSymbol *key)
	Removes a property from the object. More...

void	removeTag (const IlSymbol *tag)
	Removes a tag. More...

IlBoolean	replaceClassProperty (const IlSymbol *key, IlAny value)
	Replaces a property in this object's class. More...

IlBoolean	replaceProperty (const IlSymbol *key, IlAny value)
	Replaces a property. More...

virtual void	resize (IlvDim newW, IlvDim newH)
	Resizes a graphic object. More...

virtual void	rotate (const IlvPoint &center, IlFloat angle)
	Rotates a graphic object. More...

virtual void	scale (IlFloat zoomX, IlFloat zoomY)
	Scales the graphic object. More...

void	setCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
	Sets a new callback. More...

void	setCallback (const IlSymbol callbackType, const IlSymbol callbackName, const IlSymbol *script=0)
	Removes all previously set callbacks. More...

void	setCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
	Removes all previously set callbacks. More...

void	setCallback (IlvGraphicCallback callback, IlAny data)
	Sets the main callback function. More...

void	setCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
	Sets the callback user data for a callback function. More...

void	setCallbackData (const IlSymbol callbackType, const IlSymbol callbackName, IlAny data)
	Sets the callback user data for a callback function. More...

void	setCallbackName (const IlSymbol *callbackName)
	Sets the symbol that identifies the main callback. More...

void	setClientData (IlAny clientData)
	Sets client data. More...

void	setFirstFocusGraphic ()
	Sets the object to be first in the focus chain.

void	setFocusable (IlBoolean value)
	Set the focusable state of the object. More...

IlBoolean	setInteractor (IlvInteractor *inter)
	Attaches an interactor to the current object. More...

IlBoolean	setInteractor (const char *name)
	Attaches an interactor to this graphic object. More...

void	setLastFocusGraphic ()
	Sets the object to be last in the focus chain.

virtual void	setName (const char *name)
	Sets the name of the object. More...

IlvNamedProperty *	setNamedProperty (IlvNamedProperty *property)
	Sets a named property on the object. More...

virtual void	setNeedsInputContext (IlBoolean val)
	Specifies whether the graphic object should have locale dependent input. More...

void	setNextFocusGraphic (IlSymbol *name)
	Sets the object to be next in the focus chain. More...

void	setPreviousFocusGraphic (IlSymbol *name)
	Sets an object as previous in the focus chain. More...

void	setProperty (const IlSymbol *key, IlAny value)
	Sets a property of the object to a value. More...

virtual void	setSensitive (IlBoolean value)
	Sets the sensitivity of the object. More...

virtual void	symmetry (IlvDirection axis)
	Flips a graphic object. More...

virtual void	translate (IlvPos dx, IlvPos dy)
	Applies a transformation function on a graphic object. More...

IlvDim	w () const
	Gets the width value of the object. More...

void	w (IlvDim w)
	Sets the width value of the object. More...

virtual void	write (IlvOutputFile &output) const =0
	Writes an object description to a file. More...

IlvPos	x () const
	Gets the `x` coordinate value of the object. More...

void	x (IlvPos x)
	Sets the `x` coordinate value of the object. More...

IlvPos	y () const
	Gets the `y` coordinate value of the object. More...

void	y (IlvPos y)
	Sets the `y` coordinate value of the object. More...

virtual IlBoolean	zoomable () const
	Checks whether this object is zoomable. More...

Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...

virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...

virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...

virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...

virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvGraphic
static void	AddProperty (const IlSymbol *key, IlAny value)
	Adds a property to this object's class. More...

static void	AddToCallbackTypeList (IlUInt &count, const char const names, const IlSymbol const *types, const char newName, const IlSymbol *newType)
	Adds a callback to a list. More...

static void	AllowZoom (IlBoolean az)
	Sets or inhibits zooming. More...

static IlvClassInfo *	ClassInfo () const
	Gets class information. More...

static IlAny	GetProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
	Retrieves the property value associated with the key in this object's class. More...

static const IlvClassInfo *	HasProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
	Checks for the existence of a property for this object's class hierarchy. More...

static IlBoolean	IsZoomAllowed ()
	Checks whether zoomable objects can display themselves when zooming out. More...

static IlvGraphic *	read (IlvInputFile &file, IlvPalette *palette)
	Reads an object description from a file. More...

static IlBoolean	RemoveProperty (const IlSymbol *key)
	Removes a property from this object's class. More...

static IlBoolean	ReplaceProperty (const IlSymbol *key, IlAny value)
	Replaces a property in this object's class. More...

Detailed Description

Graphic class.

Library: views

Gauges are graphic objects that provide a representation of some value, which is bound between a minimum and a maximum value. Rogue Wave Views uses a main abstract class, IlvGauge, from which all gauge objects derive. The default interactor name for this object is "\c Gauge".

See also: IlvChartData, IlvTransformer, IlvGaugeInteractor.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclass IlvSimpleGraphic and adds the following ones:

Name	Type	Equivalent methods
`min`	Float	`getMin()`, `setMin()`
`max`	Float	`getMax()`, `setMax()`
`value`	Float	`getValue()`, `setValue()`

Constructor & Destructor Documentation

§ IlvGauge()

IlvGauge::IlvGauge	(	IlvDisplay *	display,
		const IlvRect &	drawrect,
		IlFloat	min = `0`,
		IlFloat	max = `100`,
		IlFloat	value = `50`,
		IlvPalette *	palette = `0`
	)

Constructor.

Parameters

display	The display instance.
drawrect	Specifies the size of the graphic object.
min	The minimum value of the gauge.
max	The maximum value of the gauge.
value	The current value of the gauge.
palette	The palette used to draw the graphic object.

Member Function Documentation

§ applyTransform()

virtual void IlvGauge::applyTransform ( const IlvTransformer * t )

virtual

Applies a transformation function to the graphic object.

Applies the transformer t to the shape of the object. Unless the transformation is a scaling operation, the result of applying it to certain objects can be insignificant. For example, applying a non-scaling transformer to an IlvRectangle object is meaningless, since the rectangle remains a rectangle. On the other hand, meaningful transformations can be applied to objects that are instances of types such as IlvLine or IlvPolyPoints.

Note: applyTransform() is one of the most important method to be rewritten for classes derived from IlvGraphic, since it is called by the resize(), move(), moveResize(), scale(), etc., methods.

Parameters

t	The transformer value. If `0`, no transformation is performed.

Implements IlvGraphic.

§ bboxRange()

virtual void IlvGauge::bboxRange	(	IlFloat	v1,
		IlFloat	v2,
		IlvRect &	rect,
		const IlvTransformer *	t = `0`
	)		const

pure virtual

Returns the rectangle to update when the value of the gauge changes.

Returns: The rectangular region to be updated if the value of the gauge was changing from v1 to v2.

Parameters

v1	Initial value of the gauge.
v2	Future value of the gauge.
rect	Used to return the rectangle to update.
t	The transformer. If it is specified, the graphic object is considered to be drawn through a transformation and the returned rectangle is expressed in the transformed coordinate system.

Implemented in IlvReliefGauge, IlvSliderGauge, IlvRectangularGauge, and IlvCircularGauge.

§ boundingBox()

virtual void IlvGauge::boundingBox	(	IlvRect &	bbox,
		const IlvTransformer *	t = `0`
	)		const

pure virtual

Retrieves the bounding box of the graphic object.

Sets bbox, the rectangle reference parameter, to be the bounding box of the object. Since the object can appear within a transformed environment (for example, in a multiview editor), an IlvTransformer object occurs as an optional parameter in order to compute the bounding box in the coordinate system of the transformed environment.

Parameters

bbox	The bounding box to be set.
t	A transformer value or `0` if there is no transformation.

Implements IlvGraphic.

Implemented in IlvRectangularGauge, and IlvCircularGauge.

§ draw()

virtual void IlvGauge::draw	(	IlvPort *	dst,
		const IlvTransformer *	t = `0`,
		const IlvRegion *	clip = `0`
	)		const

virtual

Draws the graphic object.

Draws the object in the given IlvPort using the transformer t.

Parameters

dst	The destination port this object is drawn onto.
t	The transformer value. If `0`, no transformation is performed.
clip	The clipping region, relative to the transformed object, or `0` if none.

Implements IlvGraphic.

Reimplemented in IlvRectangularGauge.

§ drawFocus()

virtual void IlvGauge::drawFocus	(	IlvPort *	dst,
		const IlvPalette *	palette,
		const IlvTransformer *	t = `0`,
		const IlvRegion *	clip = `0`
	)		const

virtual

Draws additional drawings for an object that has the keyboard focus.

This method is called to draw additional drawings when the graphic object has the keyboard focus. The default implementation draws a rectangle around the object. The drawing will be done inside the region returned by computeFocusRegion().

Parameters

dst	The destination port.
palette	The palette of the object.
t	The transformer value. If `0`, no transformation is performed.
clip	The clipping region.

Reimplemented from IlvGraphic.

§ drawValue()

virtual void IlvGauge::drawValue	(	IlvPort *	dst,
		const IlvTransformer *	t = `0`,
		const IlvRegion *	clip = `0`
	)		const

pure virtual

Performs the drawing representing the current value of the gauge.

Called by the member function draw() and interactors that connect to it. Draws the part of the gauge that indicates its value (such as the hand of a watch).

Parameters

dst	The destination port.
t	The transformer to apply to the drawing.
clip	The clipping region.

Implemented in IlvReliefGauge, IlvSliderGauge, IlvRectangularGauge, IlvFilledCircularGauge, and IlvCircularGauge.

§ getDefaultInteractor()

virtual const char* IlvGauge::getDefaultInteractor ( ) const

virtual

Gets the name of the default interactor for this object.

Returns: A string that identifies the object interactor that is likely to be associated with this graphic class. If it returns 0, then there is no default interactor for this graphic class.

Reimplemented from IlvGraphic.

§ getMax()

IlFloat IlvGauge::getMax ( ) const

Returns the maximum value of the gauge.

Returns: The maximum value of the gauge.

§ getMin()

IlFloat IlvGauge::getMin ( ) const

Returns the minimum value of the gauge.

Returns: The minimum value of the gauge.

§ getValue()

IlFloat IlvGauge::getValue ( ) const

Returns the current value of the gauge.

Returns: The current value of the gauge.

§ invert()

virtual void IlvGauge::invert ( IlBoolean temp = IlFalse )

virtual

Highlights the object.

Highlights the object. It is implemented as swapping the foreground and background colors of the object, but can have other implementations in derived subclasses. The parameter temp controls the way you toggle between the background and the foreground. If temp is omitted or is IlFalse, then a new palette is computed by calling the IlvDisplay::getPalette() method. If temp is IlTrue, the object palette is inverted, and thus all the objects referencing this palette will be affected.

Parameters

temp	If `IlTrue`, highlights the object.

Reimplemented from IlvSimpleGraphic.

Reimplemented in IlvReliefGauge.

§ requestValue()

virtual IlFloat IlvGauge::requestValue	(	const IlvPoint &	point,
		const IlvTransformer *	t,
		IlBoolean &	connect
	)		const

pure virtual

Returns the value of the gauge associated with a given point.

Returns: the value stored in this gauge if its moving part was at the specified location. If the point is outside the object bounding box, the function returns a reasonable value (the closest point on the object bounding box is considered).

Parameters

point	The point. If a transformer is specified, the point is considered to be transformed, i.e. expressed in the transformed coordinate system.
t	The transformer.
connect	If `IlTrue`, the provided point indicates a connection to the gauge. Mostly, this means that the point is located on the moving part of the gauge.

Implemented in IlvSliderGauge, IlvRectangularGauge, IlvFilledCircularGauge, and IlvCircularGauge.

§ setAlpha()

virtual void IlvGauge::setAlpha ( IlvIntensity alpha )

virtual

Sets the alpha value of the object.

Parameters

alpha The new alpha value.

Reimplemented from IlvSimpleGraphic.

Reimplemented in IlvReliefGauge.

§ setAntialiasingMode()

virtual void IlvGauge::setAntialiasingMode ( IlvAntialiasingMode mode )

virtual

Sets the anti-aliasing mode of the object.

Parameters

mode	The new anti-aliasing mode.

Reimplemented from IlvSimpleGraphic.

Reimplemented in IlvReliefGauge.

§ setBackground()

virtual void IlvGauge::setBackground ( IlvColor * background )

virtual

Sets the background color of the object.

Parameters

background The new background color.

Reimplemented from IlvSimpleGraphic.

§ setForeground()

virtual void IlvGauge::setForeground ( IlvColor * foreground )

virtual

Sets the foreground color of the object.

Parameters

foreground The new foreground color.

Reimplemented from IlvSimpleGraphic.

Reimplemented in IlvReliefGauge.

§ setMax()

void IlvGauge::setMax ( IlFloat max )

Sets the maximum value of the gauge.

Parameters

max	The new maximum value.

§ setMin()

void IlvGauge::setMin ( IlFloat min )

Sets the minimum value of the gauge.

Parameters

min	The new minimum value.

§ setMode()

virtual void IlvGauge::setMode ( IlvDrawMode mode )

virtual

Sets the drawing mode of the object temporarily.

Changing the IlvDrawMode attribute of an object is considered a temporary operation. You have to set the mode to its default value when you no longer need another mode different from the value IlvModeSet. The drawing mode information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite() method for more details).

Parameters

mode	The drawing mode to be set.

Reimplemented from IlvSimpleGraphic.

Reimplemented in IlvReliefGauge.

§ setOverwrite()

virtual void IlvGauge::setOverwrite ( IlBoolean over )

virtual

Sets an overwrite mode that modifies how the drawing member functions operate.

Modifies the way the drawing member functions operate. The information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite() method for more details).

Parameters

over	If `IlFalse`, sets selective hidden drawing operations.

Reimplemented from IlvSimpleGraphic.

§ setPalette()

virtual void IlvGauge::setPalette ( IlvPalette * palette )

virtual

Sets the internal palette.

The previous palette is unlocked, and palette is locked.

Parameters

palette The new palette of this object.

Reimplemented from IlvSimpleGraphic.

Reimplemented in IlvReliefGauge.

§ setValue()

virtual void IlvGauge::setValue ( IlFloat value )

virtual

Sets the current value of the gauge.

Changes the current value of the gauge.

Parameters

value The new current value.

Public Member Functions

Additional Inherited Members

Detailed Description

Accessors

Constructor & Destructor Documentation

§ IlvGauge()

Member Function Documentation

§ applyTransform()

§ bboxRange()

§ boundingBox()

§ draw()

§ drawFocus()

§ drawValue()

§ getDefaultInteractor()

§ getMax()

§ getMin()

§ getValue()

§ invert()

§ requestValue()

§ setAlpha()

§ setAntialiasingMode()

§ setBackground()

§ setForeground()

§ setMax()

§ setMin()

§ setMode()

§ setOverwrite()

§ setPalette()

§ setValue()