IlvPrintableComposite::SegmentCoordinates Class Reference

This is an abstract class that represents the concept of the position, on an axis, of a component. More...

#include <ilviews/printing/composite.h>

Inheritance diagram for IlvPrintableComposite::SegmentCoordinates:

Public Member Functions
virtual	~SegmentCoordinates ()
	The destructor.
virtual SegmentCoordinates *	clone () const =0
	This function returns a new object allocated on the heap; this object is a copy of the current object. More...
PositionCoordinate const &	getFirstPosition () const
	Gets the first PositionCoordinate of the segment. More...
PositionCoordinate const &	getLastPosition () const
	Gets the last PositionCoordinate of the segment. More...
PositionCoordinate const &	getOtherPosition (PositionCoordinate const &position) const
	Gets the other position than the given position of the segment. More...
IlBoolean	isValid () const
	Returns whether the object is valid. More...
IlBoolean	setFirstPosition (PositionCoordinate const &newPosition)
	Modifies the first PositionCoordinate. More...
IlBoolean	setLastPosition (PositionCoordinate const &newPosition)
	Modifies the last PositionCoordinate. More...

Detailed Description

This is an abstract class that represents the concept of the position, on an axis, of a component.

Library: ilvprint

A SegmentCoordinates is defined by two PositionCoordinate objects and a length. One and only one among the positions or the current objects must be deductible (DeducedPositionCoordinate or DeducedSegmentCoordinates), that is computed by the means of the two others.

Member Function Documentation

virtual SegmentCoordinates* IlvPrintableComposite::SegmentCoordinates::clone ( ) const

pure virtual

This function returns a new object allocated on the heap; this object is a copy of the current object.

Returns

A pointer to a new allocated object.

Implemented in IlvPrintableComposite::RatioRelativeSegmentCoordinates, IlvPrintableComposite::DeltaRelativeSegmentCoordinates, and IlvPrintableComposite::DeducedSegmentCoordinates.

PositionCoordinate const& IlvPrintableComposite::SegmentCoordinates::getFirstPosition

(

)

const

Gets the first PositionCoordinate of the segment.

Returns

The first PositionCoordinate of the segment.

PositionCoordinate const& IlvPrintableComposite::SegmentCoordinates::getLastPosition

(

)

const

Gets the last PositionCoordinate of the segment.

Returns

The last PositionCoordinate of the segment.

PositionCoordinate const& IlvPrintableComposite::SegmentCoordinates::getOtherPosition

(

PositionCoordinate const &

position

)

const

Gets the other position than the given position of the segment.

Returns

The other position than the given position of the segment.

IlBoolean IlvPrintableComposite::SegmentCoordinates::isValid

(

)

const

Returns whether the object is valid.

Returns

IlTrue when the object is valid, IlFalse otherwise.

IlBoolean IlvPrintableComposite::SegmentCoordinates::setFirstPosition

(

PositionCoordinate const &

newPosition

)

Modifies the first PositionCoordinate.

Warning

The object may become invalid.

Parameters

newPosition

The new first PositionCoordinate.

Returns

The validity of the object.

IlBoolean IlvPrintableComposite::SegmentCoordinates::setLastPosition

(

PositionCoordinate const &

newPosition

)

Modifies the last PositionCoordinate.

Warning

The object may become invalid.

Parameters

newPosition

The new last PositionCoordinate.

Returns

The validity of the object.