IlvCircularScale Class Reference

Graphic class. More...

#include <ilviews/graphics/cirscale.h>

Inheritance diagram for IlvCircularScale:

Public Member Functions
	IlvCircularScale (IlvDisplay display, const IlvRect &drawrect, char labels[], IlFloat start=0., IlFloat range=180., IlUShort steps=0, IlUShort substeps=0, IlBoolean in=((IlBoolean) 0), IlUShort stepsize=10, IlUShort substepsize=5, IlvPalette *palette=0)
	Constructor.
	IlvCircularScale (IlvDisplay display, const IlvRect &drawrect, const char format, IlFloat min, IlFloat max, IlFloat start=0., IlFloat range=180., IlUShort steps=0, IlUShort substeps=0, IlBoolean in=((IlBoolean) 0), IlUShort stepsize=10, IlUShort substepsize=5, IlvPalette *palette=0)
	Constructor.
virtual void	applyTransform (const IlvTransformer *t)
	Applies a transformation function to the graphic object.
virtual void	boundingBox (IlvRect &, const IlvTransformer *t=0) const
	Retrieves the bounding box of the graphic object.
const char *	className () const
	Returns the class name of an object.
virtual IlBoolean	contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
	Checks whether a point is in the object.
virtual IlvGraphic *	copy () const
	Copies this object.
virtual void	draw (IlvPort , const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphic object.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlBoolean	getDirection () const
	Retrieves the tick mark direction.
IlFloat	getRange () const
	Retrieves the angle range of this scale.
IlFloat	getStart () const
	Retrieves the start angle of this scale.
IlBoolean	isSubtypeOf (const IlvClassInfo *c) const
	Checks whether this object's class is a subclass.
IlBoolean	isSubtypeOf (const char *t) const
	Checks whether this object's class is a subclass of a given parent class.
void	setDirection (IlBoolean in)
	Sets the tick mark direction.
void	setRange (IlFloat range)
	Sets the angle range of this scale.
void	setStart (IlFloat start)
	Sets the start angle of this scale.
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file.
Static Public Member Functions
static void	AddProperty (const IlSymbol *k, IlAny v)
	Adds a property to this object's class.
static IlAny	GetProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
	Retrieves the property value associated with the key in this object's class.
static const IlvClassInfo *	HasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
	Checks for the existence of a property for this object's class hierarchy.
static IlvGraphic *	read (IlvInputFile &, IlvPalette *pal)
	Reads an object description from a file.
static IlBoolean	RemoveProperty (const IlSymbol *key)
	Removes a property from this object's class.
static IlBoolean	ReplaceProperty (const IlSymbol *k, IlAny v)
	Replaces a property in this object's class.

Detailed Description

Graphic class.

Library: views

Use this class to create circular scales like those shown in the following figure:

- Circular scales -

Constructor & Destructor Documentation

IlvCircularScale::IlvCircularScale	(	IlvDisplay *	display,
		const IlvRect &	drawrect,
		const char *	format,
		IlFloat	min,
		IlFloat	max,
		IlFloat	start = `0.`,
		IlFloat	range = `180.`,
		IlUShort	steps = `0`,
		IlUShort	substeps = `0`,
		IlBoolean	in = `((IlBoolean)0)`,
		IlUShort	stepsize = `10`,
		IlUShort	substepsize = `5`,
		IlvPalette *	palette = `0`
	)

Constructor.

Parameters:

	display	The display object that draws this object.
	drawrect	The initial size of this object.
	format	The format, as it would be given to `printf` to display the scale labels.
	min	The minimum value of this scale.
	max	The maximum value of this scale.
	start	The start angle of this scale.
	range	The angle range of this scale.
	steps	The number of steps of this scale. This is also the number of labels that are computed and displayed.
	substeps	The number of substeps that are displayed between each step.
	in	Set to `IlTrue` if the step ticks must be displayed inside the gauge. If set to `IlFalse`, the ticks are displayed outside the ellipse that define the gauge.
	stepsize	The size of the step ticks, in pixels.
	substepsize	The size of the substep ticks, in pixels.
	palette	The initial palette that is used to display this object.

IlvCircularScale::IlvCircularScale	(	IlvDisplay *	display,
		const IlvRect &	drawrect,
		char *	labels[],
		IlFloat	start = `0.`,
		IlFloat	range = `180.`,
		IlUShort	steps = `0`,
		IlUShort	substeps = `0`,
		IlBoolean	in = `((IlBoolean)0)`,
		IlUShort	stepsize = `10`,
		IlUShort	substepsize = `5`,
		IlvPalette *	palette = `0`
	)

Constructor.

Parameters:

	display	The display object that draws this object.
	drawrect	The initial size of this object.
	labels	An array of strings that are used as the initial labels of this scale. There must be at least steps strings in this array, and all strings are copied internally.
	start	The start angle of this scale.
	range	The angle range of this scale.
	steps	The number of steps of this scale. This is also the number of labels that are computed and displayed.
	substeps	The number of substeps that are displayed between each step.
	in	Set to `IlTrue` if the step ticks must be displayed inside the gauge. If set to `IlFalse`, the ticks are displayed outside the ellipse that define the gauge.
	stepsize	The size of the step ticks, in pixels.
	substepsize	The size of the substep ticks, in pixels.
	palette	The initial palette that is used to display this object.

Member Function Documentation

static void IlvCircularScale::AddProperty	(	const IlSymbol *	key,
		IlAny	value
	)			`[static]`

Adds a property to this object's class.

This static function associates the given value with the given key for the class of this object only.

Parameters:

	key	The key to be associated.
	value	The value to be associated.

Reimplemented from IlvScale.

virtual void IlvCircularScale::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.

Warning:: [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.

Reimplemented from IlvScale.

virtual void IlvCircularScale::boundingBox	(	IlvRect &	bbox,
		const IlvTransformer *	t = `0`
	)			const `[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. When there is no transformation, t is set to 0.

Parameters:

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

Implements IlvScale.

const char* IlvCircularScale::className ( ) const

Returns the class name of an object.

This method is equivalent to getClassInfo()->getClassName().

Returns:: The class name of the object. For example, for an IlvRectangle object, the className function returns "IlvRectangle".

Reimplemented from IlvScale.

virtual IlBoolean IlvCircularScale::contains	(	const IlvPoint &	p,
		const IlvPoint &	tp,
		const IlvTransformer *	t = `0`
	)			const `[virtual]`

Checks whether a point is in the object.

Checks whether the coordinates are located in the shape of this object. A transformation parameter allows you to use the view's coordinate system for this test.

Parameters:

	p	The point to be tested.
	tp	The transformed point obtained by applying the transformer t to the point p.
	t	A transformer value, or `0` if there is no transformation.

Returns:: IlTrue when the point p lies inside the outline of the object.

Reimplemented from IlvGraphic.

virtual IlvGraphic* IlvCircularScale::copy ( ) const [virtual]

Copies this object.

Allocates and returns a copy of this object. If the object is composite, the implementation of this member function makes a copy of the object's components.

Returns:: A copy of the object.

See also:: IlvPredefinedIOMembers.

Reimplemented from IlvScale.

virtual void IlvCircularScale::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 which might have the value 0. The clip parameter, which can also be 0, represents the clipping region relative to the transformed object.

Parameters:

	dst	The destination port.
	t	The transformer value. If 0, no transformation is performed.
	clip	The clipping region, or 0 if none.

Implements IlvScale.

virtual IlvClassInfo* IlvCircularScale::getClassInfo ( ) const [virtual]

Gets class information.

Returns a pointer to the IlvClassInfo object associated with this object's class.

Returns:: A pointer to the class information object of the class of this object.

Reimplemented from IlvScale.

IlBoolean IlvCircularScale::getDirection ( ) const

Retrieves the tick mark direction.

Returns:: The direction of the tick marks. It is IlTrue if the tick marks are drawn from the exterior of the scale to the center, and IlFalse if the tick marks are drawn to the outside of the scale.

static IlAny IlvCircularScale::GetProperty	(	const IlSymbol *	key,
		IlBoolean	checkSuperClass = `((IlBoolean) 0)`
	)			`[static]`

Retrieves the property value associated with the key in this object's class.

Retrieves the property value associated with the property name key. If the property cannot be found in the class of this object, and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until the property is found. If the property cannot be found, then 0 is returned.

Parameters:

	key	The key with which the property value is associated.
	checkSuperClass	`IlTrue` specifies iterative search on superclasses.

Returns:: The property value associated with the proper name key, or 0.

Reimplemented from IlvScale.

IlFloat IlvCircularScale::getRange ( ) const

Retrieves the angle range of this scale.

Returns:: The angle range of this scale in degrees. This value added to the start angle gives the location of the last tick mark.

IlFloat IlvCircularScale::getStart ( ) const

Retrieves the start angle of this scale.

Returns:: The start angle of this scale in degrees. This angle is where the first tick mark is displayed.

static const IlvClassInfo* IlvCircularScale::HasProperty	(	const IlSymbol *	key,
		IlBoolean	checkSuperClass = `((IlBoolean) 0)`
	)			`[static]`

Checks for the existence of a property for this object's class hierarchy.

Retrieves a pointer to the IlvClassInfo that indicates a class where the key property exists. If the returned value is non-0, then this property actually exists for this class. If this is not the case and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until a match is found. If the property cannot be found, then 0 is returned.

Parameters:

	key	The key with which the property value is associated.
	checkSuperClass	`IlTrue` specifies iterative search on superclasses.

Returns:: A pointer to the ClassInfo that indicates a class where the key property exists, or 0.

Reimplemented from IlvScale.

IlBoolean IlvCircularScale::isSubtypeOf ( const IlvClassInfo * classInfo ) const

Checks whether this object's class is a subclass.

This method is equivalent to getClassInfo()->isSubtypeOf(classInfo).

Parameters:

classInfo

The name of a class on which the object's class is tested.

Returns:: Either IlTrue or IlFalse, depending on whether or not this object's class is a subclass of the class indicated by classInfo.

Reimplemented from IlvScale.

IlBoolean IlvCircularScale::isSubtypeOf ( const char * parentClass ) const

Checks whether this object's class is a subclass of a given parent class.

This method is equivalent to getClassInfo()->isSubtypeOf(parentClass).

Parameters:

parentClass

A string representing the parent class.

Returns:: Either IlTrue or IlFalse, depending on whether or not this object's class inherits parentClass attributes. The parentClass parameter should be a string representing the class name of an IlvGraphic subclass. A call to this member function for a given class instance returns IlTrue if given the name of its class.

Reimplemented from IlvScale.

static IlvGraphic* IlvCircularScale::read	(	IlvInputFile &	file,
		IlvPalette *	palette
	)			`[static]`

Reads an object description from a file.

Reads an object description from the file input, given the palette graphic attributes. It reads the information that was saved by the member function write to be able to create a new instance of this object. Usually, because of the availability of the constructor that expects an IlvInputFile, read should be equivalent to:

 IlvGraphic*
 MyClass::read(IlvInputFile& file, IlvPalette* palette)
 {
     return new MyClass(file, palette);
 }

In the following example, the static member function read of the IlvLabel class could have the following form:

 IlvGraphic*
 IlvLabel::read(IlvInputFile& file, IlvPalette* pal)
 {
     IlvPoint pos;
     file.getStream() >> pos;     // Read the position field
     return new IlvLabel(pal->getDisplay(), pos,
     IlvReadString(file.getStream()), pal);
 }

Parameters:

	file	The name of the file to be read from.
	palette	The name of the palette for the object.

See also:: DeclareTypeInfoRO, DeclareTypeInfo, IlvPredefinedIOMembers.

Warning:: [note] The read method is not capitalized like other static methods so that it is consistent with the write method.

Reimplemented from IlvScale.

static IlBoolean IlvCircularScale::RemoveProperty ( const IlSymbol * key ) [static]

Removes a property from this object's class.

This static function removes the indicated property to the class of this object.

Parameters:

key

The key property to be removed.

Returns:: IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvScale.

static IlBoolean IlvCircularScale::ReplaceProperty	(	const IlSymbol *	key,
		IlAny	value
	)			`[static]`

Replaces a property in this object's class.

This static function replaces the indicated property value to the class of this object.

Parameters:

	key	The key to be replaced.
	value	The value to be replaced.

Returns:: IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvScale.

void IlvCircularScale::setDirection ( IlBoolean in )

Sets the tick mark direction.

Parameters:

in

The new tick mark direction.

void IlvCircularScale::setRange ( IlFloat range )

Sets the angle range of this scale.

Parameters:

range

The new angle range of this scale in degrees. This value can be negative for a clockwise scale.

void IlvCircularScale::setStart ( IlFloat start )

Sets the start angle of this scale.

Parameters:

start

The new start angle in degrees.

virtual void IlvCircularScale::write ( IlvOutputFile & output ) const [virtual]

Writes an object description to a file.

Writes out, in a file, the object description. This description contains all the information necessary to create an exact copy of this object by means of the member function read. Information concerning any IlvPalette object attached to this object is written out by the object containers. All other information, such as the position and size of the object, is written out by this virtual member function.
For example, suppose we have an IlvLabel class that implements a graphic object drawn as a text string at a given position. It maintains its position in an internal IlvPoint field called _position and its textual content in an internal character array field called _text. The only information we need to save is the contents of those fields. So, the member function write of such an object should have the following form:

 void
 IlvLabel::write(IlvOutputFile& file) const
 {
     // Save the position field
     file.getStream() << IlvSpc() << _position;
     // Save the text field
     IlvWriteString(file.getStream(), _text);
 }

Parameters:

output

The the output file to be written to.

See also:: DeclareTypeInfo.

Reimplemented from IlvScale.

Rogue Wave ViewsFoundation Package API Reference Guide

IlvCircularScale Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Rogue Wave Views
Foundation Package API Reference Guide