IlvPolyPointsSelection Class Reference

Represents the selectable portions of an IlvPolyPoints object. More...

#include <ilviews/graphics/polyptsel.h>

Inheritance diagram for IlvPolyPointsSelection:

List of all members.

Public Member Functions
	IlvPolyPointsSelection (IlvDisplay *display, IlvGraphic *object, IlvDim size=IlvDefaultSelectionSize, IlvPalette *palette=0)
	Constructor.
void	boundingBox (IlvRect &bbox, const IlvTransformer *t) const
	Retrieves the bounding box of the graphic object.
const char *	className () const
	Returns the class name of an object.
void	computeRegion (IlvRegion &r, const IlvTransformer *t=0) const
	Returns the region covered by the object.
virtual IlvGraphic *	copy () const
	Copies this object.
void	draw (IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip=0) const
	Draws the graphic object.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlBoolean	getHandleLocation (IlUInt idx, IlvPoint &p, const IlvTransformer *t) const
	Returns the location of a given selection handle.
IlUInt	getHandlesCount (const IlvTransformer *t=0) const
	Returns the number of selection handles.
IlvPolyPoints *	getPolyPoints () const
	Gets the IlvPolyPoints object attached to this selection.
IlvInteractor *	getSelectionInteractor () const
	Gets the IlvInteractor used to edit this object.
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

Represents the selectable portions of an IlvPolyPoints object.

Library: views

The IlvPolyPointsSelection class is used to represent the selectable portions of an IlvPolyPoints object. It draws markers at each point of its attached IlvPolyPoints and provides means to edit those points independently from each other. This class is used by the selection and IlvEditPointsInteractor interactors.

- IlvPolyPointsSelection -

See also:

IlvMarker.

---

Constructor & Destructor Documentation

IlvPolyPointsSelection::IlvPolyPointsSelection	(	IlvDisplay *	display,
		IlvGraphic *	object,
		IlvDim	size = IlvDefaultSelectionSize,
		IlvPalette *	palette = 0
	)

Constructor.

The constructor initializes a new IlvPolyPointsSelection object. The handle size is provided by size.

Parameters:

	display	The display from which graphic resources are read.
	object	The object of type IlvPolyPoints.
	size	The handle size, defined in pixels.
	palette	The palette of the object.

---

Member Function Documentation

static void IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

void IlvPolyPointsSelection::boundingBox	(	IlvRect &	bbox,
		const IlvTransformer *	t
	)			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 IlvDrawSelection.

const char* IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

void IlvPolyPointsSelection::computeRegion	(	IlvRegion &	r,
		const IlvTransformer *	t = 0
	)			const [virtual]

Returns the region covered by the object.

This method returns in region the region that covers the selection object if it is displayed with the transformer t. The default implementation fills the region with the rectangles returned by the IlvDrawSelection::getHandleRect method for each selection handle.

Parameters:

	r	The returned region.
	t	The transformer applied to this object.

Reimplemented from IlvDrawSelection.

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

Implements IlvGraphic.

Reimplemented in IlvSplineSelection.

void IlvPolyPointsSelection::draw	(	IlvPort *	dst,
		const IlvTransformer *	t,
		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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

virtual IlvClassInfo* IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

IlBoolean IlvPolyPointsSelection::getHandleLocation	(	IlUInt	idx,
		IlvPoint &	p,
		const IlvTransformer *	t
	)			const [virtual]

Returns the location of a given selection handle.

This method must be redefined in subclasses.

Parameters:

	idx	The index of the considered handle.
	p	The returned point.
	t	The transformer applied to the object.

Returns:

IlTrue if idx is a valid index and IlFalse otherwise.

Implements IlvDrawSelection.

Reimplemented in IlvSplineSelection.

IlUInt IlvPolyPointsSelection::getHandlesCount

(

const IlvTransformer *

t = 0

)

const [virtual]

Returns the number of selection handles.

This method must be redefined in subclasses.

Parameters:

t

The transformer applied to the object.

Returns:

The number of selection handles.

Implements IlvDrawSelection.

IlvPolyPoints* IlvPolyPointsSelection::getPolyPoints

(

)

const

Gets the IlvPolyPoints object attached to this selection.

Returns:

The IlvPolyPoints used by the selection.

static IlAny IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

IlvInteractor* IlvPolyPointsSelection::getSelectionInteractor

(

)

const [virtual]

Gets the IlvInteractor used to edit this object.

Returns:

An IlvInteractor that can be used to track events and apply modifications to the edited object.

Reimplemented from IlvDrawSelection.

Reimplemented in IlvSplineSelection.

static const IlvClassInfo* IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

IlBoolean IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

IlBoolean IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

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

Reimplemented in IlvSplineSelection.

static IlBoolean IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.

static IlBoolean IlvPolyPointsSelection::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 IlvDrawSelection.

Reimplemented in IlvSplineSelection.