Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvPrintableComposite::DeltaRelativeSegmentCoordinates Class Reference

This class is used to represent the position in pixel, on an axis, of a component relatively to the bounding box of an IlvPrintableComposite. More...

#include <ilviews/printing/composite.h>

Inheritance diagram for IlvPrintableComposite::DeltaRelativeSegmentCoordinates:
IlvPrintableComposite::RelativeSegmentCoordinates IlvPrintableComposite::SegmentCoordinates

Public Member Functions

 DeltaRelativeSegmentCoordinates (PositionCoordinate const &first, PositionCoordinate const &last, IlvDim length)
 The constructor. More...
 
virtual SegmentCoordinatesclone () const
 This function returns a new object allocated on the heap; this object is a copy of the current object. More...
 
- Public Member Functions inherited from IlvPrintableComposite::RelativeSegmentCoordinates
void setLength (IlvDim newLength)
 Sets the internal value of the length. More...
 
- Public Member Functions inherited from IlvPrintableComposite::SegmentCoordinates
virtual ~SegmentCoordinates ()
 The destructor.
 
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 class is used to represent the position in pixel, on an axis, of a component relatively to the bounding box of an IlvPrintableComposite.

Library: ilvprint

Constructor & Destructor Documentation

◆ DeltaRelativeSegmentCoordinates()

IlvPrintableComposite::DeltaRelativeSegmentCoordinates::DeltaRelativeSegmentCoordinates ( PositionCoordinate const &  first,
PositionCoordinate const &  last,
IlvDim  length 
)

The constructor.

Parameters
firstThe position of the start point of the segment.
lastThe position of the last point of the segment.
lengthThe length of the segment.

Member Function Documentation

◆ clone()

virtual SegmentCoordinates* IlvPrintableComposite::DeltaRelativeSegmentCoordinates::clone ( ) const
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.

Implements IlvPrintableComposite::SegmentCoordinates.