IlvArrowPolyline Class Reference

Graphic class. More...

#include <ilviews/graphics/polyline.h>

Inheritance diagram for IlvArrowPolyline:

List of all members.

Public Member Functions
	IlvArrowPolyline (IlvDisplay *display, IlBoolean alllines, IlFloat atpos, const IlvPoint &p1, const IlvPoint &p2, const IlvPoint &p3, const IlvPoint &p4, IlvPalette *palette=0)
	Constructor.
	IlvArrowPolyline (IlvDisplay *display, IlBoolean alllines, IlFloat atpos, IlUInt count, IlvPoint *points, IlvPalette *palette=0)
	Constructor.
void	boundingBox (IlvRect &, const IlvTransformer *=0) const
	Retrieves the bounding box of the graphic object.
const char *	className () const
	Returns the class name of an object.
virtual IlvGraphic *	copy () const
	Copies this object.
virtual void	draw (IlvPort *, const IlvTransformer *=0, const IlvRegion *=0) const
	Draws the graphic object.
IlFloat	getArrowPosition () const
	Returns the position of the arrow.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
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	setArrowPosition (IlFloat p)
void	useAllLines (IlBoolean value)
	Specifies whether to draw an arrow on all lines.
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

An IlvArrowPolyline object appears as a polyline and adds one or more arrows to the various lines.

- IlvArrowPolyline -

See also:

IlvArrowLine.

---

Constructor & Destructor Documentation

IlvArrowPolyline::IlvArrowPolyline	(	IlvDisplay *	display,
		IlBoolean	alllines,
		IlFloat	atpos,
		IlUInt	count,
		IlvPoint *	points,
		IlvPalette *	palette = 0
	)

Constructor.

Creates an IlvArrowPolyline object from an array of points.

Parameters:

	allLines	Indicates whether an arrow is to be drawn on each line or only on the last line.
	atpos	Specifies the position of the arrow relative to a line, as in the IlvArrowLine class. It must be in the range [0.,1.].
	count	The number of points in the array.
	points	The array of points. The array is copied.
	palette	The palette used to draw the graphic object.

IlvArrowPolyline::IlvArrowPolyline	(	IlvDisplay *	display,
		IlBoolean	alllines,
		IlFloat	atpos,
		const IlvPoint &	p1,
		const IlvPoint &	p2,
		const IlvPoint &	p3,
		const IlvPoint &	p4,
		IlvPalette *	palette = 0
	)

Constructor.

Creates a four-point IlvArrowPolyline.

Parameters:

	allLines	Indicates whether an arrow is to be drawn on each line or only on the last line.
	atpos	Specifies the position of the arrow relative to a line, as in the IlvArrowLine class. It must be in the range [0.,1.].
	p1	The first point.
	p2	The second point.
	p3	The third point.
	p4	The fourth point.
	palette	The palette used to draw the graphic object.

---

Member Function Documentation

static void IlvArrowPolyline::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 IlvPolyline.

void IlvArrowPolyline::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.

Reimplemented from IlvPolyPoints.

const char* IlvArrowPolyline::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 IlvPolyline.

virtual IlvGraphic* IlvArrowPolyline::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 IlvPolyline.

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

Reimplemented from IlvPolyline.

IlFloat IlvArrowPolyline::getArrowPosition

(

)

const

Returns the position of the arrow.

Returns:

The position of the arrow.

virtual IlvClassInfo* IlvArrowPolyline::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 IlvPolyline.

static IlAny IlvArrowPolyline::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 IlvPolyline.

static const IlvClassInfo* IlvArrowPolyline::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 IlvPolyline.

IlBoolean IlvArrowPolyline::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 IlvPolyline.

IlBoolean IlvArrowPolyline::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 IlvPolyline.

static IlvGraphic* IlvArrowPolyline::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 IlvPolyline.

static IlBoolean IlvArrowPolyline::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 IlvPolyline.

static IlBoolean IlvArrowPolyline::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 IlvPolyline.

void IlvArrowPolyline::setArrowPosition

(

IlFloat

p

)

Sets the position of the arrow.

void IlvArrowPolyline::useAllLines

(

IlBoolean

value

)

Specifies whether to draw an arrow on all lines.

Parameters:

value

IlTrue to draw an arrow on all lines, IlFalse to draw an arrow on the last line only.

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