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

This class is used to represent the concept of the end point of a segment with a percentage of the bounding box of an IlvPrintableComposite. The ratio is actually stored in hundredths of a percent. More...

#include <ilviews/printing/composite.h>

Inheritance diagram for IlvPrintableComposite::RatioRelativePositionCoordinate:
IlvPrintableComposite::RelativePositionCoordinate IlvPrintableComposite::PositionCoordinate

Public Member Functions

 RatioRelativePositionCoordinate (IlvPos position, IlBoolean isRelativeToFirst=IlTrue)
 The constructor. More...
 
virtual PositionCoordinateclone () 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::RelativePositionCoordinate
 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...
 
RelativePositionCoordinateoperator= (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...
 

Detailed Description

This class is used to represent the concept of the end point of a segment with a percentage of the bounding box of an IlvPrintableComposite. The ratio is actually stored in hundredths of a percent.

Library: ilvprint

Constructor & Destructor Documentation

◆ RatioRelativePositionCoordinate()

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

The constructor.

Parameters
positionThe position (ratio to the reference segment).
isRelativeToFirstFlag to specify whether the position is relative to the first or the last position of the reference segment.

Member Function Documentation

◆ clone()

virtual PositionCoordinate* IlvPrintableComposite::RatioRelativePositionCoordinate::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::PositionCoordinate.