IlvPrintableComposite::RelativePositionCoordinate Class Reference

This abstract class is used to represent the concept of the end point of a segment relatively to the bounding box of an IlvPrintableComposite. More...

#include <ilviews/printing/composite.h>

Inheritance diagram for IlvPrintableComposite::RelativePositionCoordinate:

List of all members.

Public Member Functions
	RelativePositionCoordinate (RelativePositionCoordinate const &other)
	The copy constructor.
	RelativePositionCoordinate (IlvPos position, IlBoolean isRelativeToFirst=((IlBoolean) 1))
	The constructor.
IlvPos	getPosition () const
	Gets the value of the position.
IlBoolean	isRelativeToFirstReferencePosition () const
	Returns whether the position is relative to the first position of the reference.
RelativePositionCoordinate &	operator= (RelativePositionCoordinate const &other)
	The assignment operator.
void	setPosition (IlvPos newPosition)
	Sets the internal value of the position.
void	setRelativeToFirstReferencePosition (IlBoolean isRelativeToFirst)
	Sets whether the position is relative to the first position of the reference.

---

Detailed Description

This abstract class is used to represent the concept of the end point of a segment relatively to the bounding box of an IlvPrintableComposite.

Library: ilvprint

---

Constructor & Destructor Documentation

IlvPrintableComposite::RelativePositionCoordinate::RelativePositionCoordinate	(	IlvPos	position,
		IlBoolean	isRelativeToFirst = ((IlBoolean) 1)
	)

The constructor.

Parameters:

	position	The position.
	isRelativeToFirst	Flag to specify whether the position is relative to the first or the last position of the reference segment.

IlvPrintableComposite::RelativePositionCoordinate::RelativePositionCoordinate

(

RelativePositionCoordinate const &

other

)

The copy constructor.

Parameters:

other

Another instance of this class.

---

Member Function Documentation

IlvPos IlvPrintableComposite::RelativePositionCoordinate::getPosition

(

)

const

Gets the value of the position.

This is the value given as parameter of the constructor or set by setPosition.

Returns:

The value of the position.

See also:

setPosition

IlBoolean IlvPrintableComposite::RelativePositionCoordinate::isRelativeToFirstReferencePosition

(

)

const

Returns whether the position is relative to the first position of the reference.

Returns:

IlTrue when it is relative to the first position of the reference, IlFalse otherwise.

See also:

setRelativeToFirstReferencePosition

RelativePositionCoordinate& IlvPrintableComposite::RelativePositionCoordinate::operator=

(

RelativePositionCoordinate const &

other

)

The assignment operator.

Parameters:

other

Another instance of this class.

Returns:

A reference to the current object.

void IlvPrintableComposite::RelativePositionCoordinate::setPosition

(

IlvPos

newPosition

)

Sets the internal value of the position.

Parameters:

The

new value of the position.

See also:

getPosition()

void IlvPrintableComposite::RelativePositionCoordinate::setRelativeToFirstReferencePosition

(

IlBoolean

isRelativeToFirst

)

Sets whether the position is relative to the first position of the reference.

Parameters:

isRelativeToFirst

IlTrue when it is relative to the first position of the reference, IlFalse otherwise.

See also:

isRelativeToFirstReferencePosition