IlvPolyline Class Reference

Graphic class. More...

#include <ilviews/graphics/polyline.h>

Inheritance diagram for IlvPolyline:

List of all members.

Public Member Functions
	IlvPolyline (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0)
	Constructor.
	IlvPolyline (IlvDisplay *display, const IlvPoint &p1, const IlvPoint &p2, const IlvPoint &p3, const IlvPoint &p4, IlvPalette *palette=0)
	Constructor.
	IlvPolyline (IlvDisplay *display, IlUInt count, IlvPoint *points, IlvPalette *palette=0)
	Constructor.
const char *	className () const
	Returns the class name of an object.
virtual IlBoolean	contains (const IlvPoint &, 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	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.
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 IlvPolyline object appears as connected segments.

- IlvPolyline -

---

Constructor & Destructor Documentation

IlvPolyline::IlvPolyline	(	IlvDisplay *	display,
		IlUInt	count,
		IlvPoint *	points,
		IlvPalette *	palette = 0
	)

Constructor.

This constructor creates a polyline object from an array of points.

Parameters:

	display	The display instance.
	count	The number of points in the array. Must not be 0.
	points	The array of points. This array is internally copied.
	palette	The palette used to draw the polyline.

IlvPolyline::IlvPolyline	(	IlvDisplay *	display,
		const IlvPoint &	p1,
		const IlvPoint &	p2,
		const IlvPoint &	p3,
		const IlvPoint &	p4,
		IlvPalette *	palette = 0
	)

Constructor.

This constructor creates a four-point polyline. Such a graphic object can perform complex geometric transformations (rotation, deformation, etc.) that IlvRectangle does not support.

Parameters:

	display	The display instance.
	p1	Specifies the first point of the polyline.
	p2	Specifies the second point of the polyline.
	p3	Specifies the third point of the polyline.
	p4	Specifies the forth point of the polyline.
	palette	The palette used to draw the polyline.

IlvPolyline::IlvPolyline	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlvPalette *	palette = 0
	)

Constructor.

This constructor creates a rectangular polyline. Such a graphic object can perform complex geometric transformations (rotation, deformation, etc.) that IlvRectangle does not support.

Parameters:

	display	The display instance.
	rect	The rectangle specifying the geometry of the polyline.
	palette	The palette used to draw the polyline.

---

Member Function Documentation

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvPolygon.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.

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

Reimplemented in IlvOutlinePolygon, IlvPolygon, and IlvArrowPolyline.