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:

Public Member Functions
	RelativePositionCoordinate (IlvPos position, IlBoolean isRelativeToFirst=IlTrue)
	The constructor. More...
	RelativePositionCoordinate (RelativePositionCoordinate const &other)
	The copy constructor. More...
IlvPos	getPosition () const
	Gets the value of the position. More...
IlBoolean	isRelativeToFirstReferencePosition () const
	Returns whether the position is relative to the first position of the reference. More...
RelativePositionCoordinate &	operator= (RelativePositionCoordinate const &other)
	The assignment operator. More...
void	setPosition (IlvPos newPosition)
	Sets the internal value of the position. More...
void	setRelativeToFirstReferencePosition (IlBoolean val)
	Sets whether the position is relative to the first position of the reference. More...
Public Member Functions inherited from IlvPrintableComposite::PositionCoordinate
	PositionCoordinate ()
	The constructor. More...
virtual PositionCoordinate *	clone () const =0
	This function returns a new object allocated on the heap, this object is a copy of the current object. More...

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

RelativePositionCoordinate() [1/2]

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

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.

RelativePositionCoordinate() [2/2]

IlvPrintableComposite::RelativePositionCoordinate::RelativePositionCoordinate

(

RelativePositionCoordinate const &

other

)

The copy constructor.

Parameters

other

Another instance of this class.

Member Function Documentation

getPosition()

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

isRelativeToFirstReferencePosition()

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

operator=()

RelativePositionCoordinate& IlvPrintableComposite::RelativePositionCoordinate::operator=

(

RelativePositionCoordinate const &

other

)

The assignment operator.

Parameters

other

Another instance of this class.

Returns

A reference to the current object.

setPosition()

void IlvPrintableComposite::RelativePositionCoordinate::setPosition

(

IlvPos

newPosition

)

Sets the internal value of the position.

Parameters

newPosition

The new value of the position.

See also

getPosition()

setRelativeToFirstReferencePosition()

void IlvPrintableComposite::RelativePositionCoordinate::setRelativeToFirstReferencePosition

(

IlBoolean

val

)

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

Parameters

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

See also

isRelativeToFirstReferencePosition