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

Scale class. More...

#include <ilviews/graphics/scale.h>

Inheritance diagram for IlvScale:
IlvSimpleGraphic IlvGraphic IlvValueInterface IlvCircularScale IlvRectangularScale

Public Member Functions

 IlvScale (IlvDisplay *display, const IlvRect &drawrect, char *labels[], IlUShort steps=2, IlUShort substeps=0, IlUShort stepsize=10, IlUShort substepsize=5, IlvPalette *palette=0)
 Constructor. More...
 
 IlvScale (IlvDisplay *display, const IlvRect &drawrect, const char *format=0, IlFloat min=0, IlFloat max=100, IlUShort steps=0, IlUShort substeps=0, IlUShort stepsize=10, IlUShort substepsize=5, IlvPalette *palette=0)
 Constructor. More...
 
virtual void applyTransform (const IlvTransformer *t)
 Applies a transformation function to the graphic object. More...
 
virtual void boundingBox (IlvRect &, const IlvTransformer *t=0) const =0
 Retrieves the bounding box of the graphic object. More...
 
virtual void draw (IlvPort *, const IlvTransformer *t=0, const IlvRegion *clip=0) const =0
 Draws the graphic object. More...
 
const char * getFormat () const
 Gets the format of the step labels. More...
 
const char * getLabel (IlUShort idx) const
 Gets a label. More...
 
char *const * getLabels () const
 Gets the labels. More...
 
void getLabelSizes (IlUShort idx, IlvDim &w, IlvDim &h, IlvDim &d) const
 Gets a label's sizes. More...
 
IlFloat getMax () const
 Gets the maximum value of the scale. More...
 
IlFloat getMin () const
 Gets the minimum value of the scale. More...
 
IlUShort getSteps () const
 Gets the number of steps. More...
 
IlUShort getStepSize () const
 Gets the step size. More...
 
IlUShort getSubSteps () const
 Gets the number of substeps. More...
 
IlUShort getSubStepSize () const
 Gets the substep size. More...
 
virtual void setFont (IlvFont *)
 Sets the font of the object. More...
 
void setFormat (const char *format)
 Sets the format of the step labels. More...
 
void setLabel (IlUShort idx, const char *label)
 Sets a label. More...
 
void setLabels (IlUShort count, const char *const *labels=0)
 Sets the labels. More...
 
void setLabels (IlUShort count, IlFloat min, IlFloat max, const char *format)
 Sets the labels. More...
 
void setMax (IlFloat max)
 Sets the maximum value of the scale. More...
 
void setMin (IlFloat min)
 Sets the minimum value of the scale. More...
 
virtual void setPalette (IlvPalette *)
 Sets the internal palette. More...
 
void setSteps (IlUShort steps)
 Sets the number of steps. More...
 
void setStepSize (IlUShort stepsize)
 Sets the step size. More...
 
void setSubSteps (IlUShort substeps)
 Sets the number of substeps. More...
 
void setSubStepSize (IlUShort substepsize)
 Sets the substep size. More...
 
- Public Member Functions inherited from IlvSimpleGraphic
 IlvSimpleGraphic (IlvDisplay *display, IlvPalette *palette=0)
 Initializes a new IlvSimpleGraphic. More...
 
virtual ~IlvSimpleGraphic ()
 Destructor. More...
 
virtual void applyResources (const char *, const char *, const char *, const char *, IlvDisplay *=0)
 Applies resources on a graphic object. More...
 
IlvIntensity getAlpha () const
 Retrieves the alpha value. More...
 
IlvAntialiasingMode getAntialiasingMode () const
 Retrieves the anti-aliasing mode. More...
 
IlvArcMode getArcMode () const
 Retrieves the arc mode. More...
 
IlvColorgetBackground () const
 Retrieves the background color. More...
 
IlvColorPatterngetColorPattern () const
 Retrieves the color pattern. More...
 
virtual IlvDisplaygetDisplay () const
 Retrieves the IlvDisplay instance. More...
 
IlvFillRule getFillRule () const
 Retrieves the fill rule. More...
 
IlvFillStyle getFillStyle () const
 Retrieves the fill style. More...
 
IlvFontgetFont () const
 Retrieves the font. More...
 
IlvColorgetForeground () const
 Retrieves the foreground color. More...
 
IlvGradientPatterngetGradientPattern () const
 Retrieves the gradient pattern. More...
 
IlvLineStylegetLineStyle () const
 Retrieves the line style. More...
 
IlUShort getLineWidth () const
 Retrieves the line width. More...
 
virtual IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look & feel handler used by this object. More...
 
virtual int getLookupStringInputMethod (IlvEvent &event, char *bufferReturn, int bytesBuffer, int *statusReturn)
 Gets the preedit string from an input method. More...
 
IlvDrawMode getMode () const
 Retrieves the draw mode. More...
 
IlBoolean getOverwrite () const
 Retrieves the overwrite mode. More...
 
IlvPalettegetPalette () const
 Retrieves the internal palette value. More...
 
IlvPatterngetPattern () const
 Retrieves the pattern. More...
 
virtual void invert (IlBoolean=IlFalse)
 Highlights the object. More...
 
virtual void registerInputMethod () const
 Controls the connection of a graphic object to an input method. More...
 
virtual void setAlpha (IlvIntensity)
 Sets the alpha value of the object. More...
 
virtual void setAntialiasingMode (IlvAntialiasingMode)
 Sets the anti-aliasing mode of the object. More...
 
virtual void setArcMode (IlvArcMode)
 Sets the arc mode of the object. More...
 
virtual void setBackground (IlvColor *)
 Sets the background color of the object. More...
 
virtual void setColorPattern (IlvColorPattern *)
 Sets the color pattern of the object. More...
 
virtual void setFillRule (IlvFillRule)
 Sets the fill rule of the object. More...
 
virtual void setFillStyle (IlvFillStyle)
 Sets the fill style of the object. More...
 
virtual void setFocusValuesInputMethod (IlUShort count, const IlvImValue *values) const
 Controls the interaction between a simple graphic object and an input method. More...
 
virtual void setForeground (IlvColor *)
 Sets the foreground color of the object. More...
 
virtual void setGradientPattern (IlvGradientPattern *)
 Sets the gradient pattern of the object. More...
 
virtual void setHolder (IlvGraphicHolder *)
 Sets the object's holder. More...
 
virtual void setLineStyle (IlvLineStyle *)
 Sets the line style of the object. More...
 
virtual void setLineWidth (IlUShort)
 Sets the line width of the object. More...
 
virtual void setMode (IlvDrawMode)
 Sets the drawing mode of the object temporarily. More...
 
virtual void setOverwrite (IlBoolean)
 Sets an overwrite mode that modifies how the drawing member functions operate. More...
 
virtual void setPattern (IlvPattern *)
 Sets the pattern of the object. More...
 
virtual void setValuesInputMethod (IlUShort count, const IlvImValue *values) const
 Controls the interaction between a graphic object and an input method. More...
 
virtual void unRegisterInputMethod () const
 Controls the disconnection of a graphic object from an input method. More...
 
virtual void unsetFocusInputMethod () const
 Controls the interaction between a graphic object and an input method. More...
 
- Public Member Functions inherited from IlvGraphic
void addCallback (const IlSymbol *callbackType, const IlSymbol *callbackName, const IlSymbol *script=0)
 Adds a callback function to a callback list. More...
 
void addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Adds a callback function to a callback list. More...
 
void addCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
 Adds a callback function to a callback list. More...
 
void addClassProperty (const IlSymbol *key, IlAny value)
 Adds a property to this object's class. More...
 
void addProperty (const IlSymbol *key, IlAny value)
 Adds a specific property to the object. More...
 
void addTag (const IlSymbol *tag)
 Adds a tag. More...
 
virtual void apply (IlvApplyObject function, IlAny arg)
 Applies a function to objects that compose another object. More...
 
IlBoolean applyAttribute (const char *attributeClassName, const char *value, IlAny checkData=0) const
 Applies attributes. More...
 
IlBoolean applyAttribute (const char *attributeClassName, IlFloat value, IlAny checkData=0) const
 Applies attributes. More...
 
IlBoolean applyAttribute (const char *attributeClassName, IlInt value, IlAny checkData=0) const
 Applies attributes. More...
 
virtual void applyReferences (IlvApplyObject function, IlAny arg)
 Applies a function to objects that are referenced by another object. More...
 
virtual void callCallbacks (const IlSymbol *callbackType)
 Calls every callback of a given type. More...
 
const char * className () const
 Returns the class name of an object. More...
 
virtual void computeFocusRegion (IlvRegion &r, const IlvTransformer *t=0) const
 Computes the region needed for the drawing of the focus. More...
 
IlBoolean contains (const IlvPoint &p) const
 Checks whether a point is in the object. More...
 
virtual IlBoolean contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
 Checks whether a point is in the object. More...
 
virtual IlvGraphiccopy () const =0
 Copies this object. More...
 
void draw (IlvPort *dst, const IlvTransformer *t, const IlvRect *clip) const
 Draws a graphic object. More...
 
virtual void drawFocus (IlvPort *dst, const IlvPalette *palette, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws additional drawings for an object that has the keyboard focus. More...
 
virtual void getAccessors (const IlSymbol *const **, const IlvValueTypeClass *const **, IlUInt &) const
 Retrieves the list of available accessors of an object. More...
 
IlvGraphicCallback getCallback () const
 Gets the main callback function. More...
 
IlvGraphicCallback getCallback (const IlSymbol *callbackType) const
 Gets a callback. More...
 
IlAny getCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Gets a callback user data. More...
 
IlAny getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Gets a callback user data. More...
 
IlSymbolgetCallbackName () const
 Gets the symbol that identifies the main callback. More...
 
IlSymbolgetCallbackName (const IlSymbol *callbackType) const
 Gets the name of a callback. More...
 
virtual IlUInt getCallbackTypes (const char *const **names, const IlSymbol *const **types) const
 Gets the number of register callback types for the object. More...
 
virtual IlvGraphicgetChildAt (IlUInt index) const
 Returns the sub-object of the graphic object specified by index. More...
 
virtual IlvGraphicgetChildByName (const char *name) const
 Returns the sub-object of the graphic object specified by a name. More...
 
virtual IlUInt getChildCount () const
 Returns the number of children of this graphic object. More...
 
virtual IlInt getChildIndex (const IlvGraphic *object) const
 Returns the index of the specified sub-object in this graphic object. More...
 
virtual IlvGraphic *const * getChildren (IlUInt &count) const
 Returns an array containing the sub-objects of this graphic object. More...
 
virtual IlvClassInfogetClassInfo () const
 Gets class information. More...
 
IlAny getClassProperty (const IlSymbol *key, IlBoolean checkParent=IlFalse) const
 Retrieves the indicated property value in the class of this object. More...
 
IlAny getClientData () const
 Gets client data. More...
 
virtual const char * getDefaultInteractor () const
 Gets the name of the default interactor for this object. More...
 
virtual IlvGraphicHoldergetHolder () const
 Gets a pointer to an object's holder. More...
 
IlvInteractorgetInteractor () const
 Returns the interactor associated with the current object. More...
 
const char * getName () const
 Gets the name of the object. More...
 
IlvNamedPropertygetNamedProperty (const IlSymbol *name) const
 Gets a named property. More...
 
IlSymbolgetNextFocusGraphic () const
 Gets the next object in the focus chain. More...
 
IlSymbolgetPreviousFocusGraphic () const
 Gets the previous object in the focus chain. More...
 
IlAny getProperty (const IlSymbol *key) const
 Gets a property. More...
 
IlvSmartSetgetSmartSet () const
 Gets the smart set object containing this graphic object. More...
 
const IlSymbol *const * getTags (IlUInt &count) const
 Returns all the tags applied to this object. More...
 
IlvDim h () const
 Gets the height value of the object. More...
 
void h (IlvDim h)
 Sets the height value of the object. More...
 
IlBoolean hasCallback (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Checks whether a callback function is in a callback list. More...
 
IlBoolean hasCallback (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Checks whether a callback function is in a callback list. More...
 
IlBoolean hasCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Checks whether a callback function has user data. More...
 
IlBoolean hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Checks whether a callback function has user data. More...
 
const IlvClassInfohasClassProperty (const IlSymbol *key, IlBoolean s=IlFalse) const
 Checks for a class where the keyed property exists. More...
 
IlBoolean hasProperty (const IlSymbol *key) const
 Checks whether the object has a particular property. More...
 
IlBoolean hasTag (const IlSymbol *tag) const
 Checks whether the object has a specific tag. More...
 
IlBoolean inside (const IlvRect &r) const
 Determines whether a rectangle is inside the bounding box. More...
 
IlBoolean inside (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
virtual IlBoolean inside (const IlvRegion &r, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
IlBoolean intersects (const IlvRect &r) const
 Checks whether a rectangle intersects the bounding box. More...
 
IlBoolean intersects (const IlvRect &r, const IlvRect &tr, const IlvTransformer *t=0) const
 Checks whether a rectangle intersects the bounding box with transformation applied. More...
 
virtual IlBoolean intersects (const IlvRegion &r, const IlvTransformer *t=0) const
 Checks whether a region intersects the bounding box with transformation applied. More...
 
IlBoolean isFirstFocusGraphic () const
 Checks whether the object is first in the focus chain. More...
 
IlBoolean isFocusable () const
 Checks whether the object can receive the keyboard focus. More...
 
IlBoolean isInSmartSet () const
 Checks whether a graphic object belongs to a smart set. More...
 
IlBoolean isLastFocusGraphic () const
 Checks whether the object is last in the focus chain. More...
 
IlBoolean isSensitive () const
 Checks whether the object is sensitive. More...
 
IlBoolean isSubtypeOf (const char *parentClass) const
 Checks whether this object's class is a subclass of a given parent class. More...
 
IlBoolean isSubtypeOf (const IlvClassInfo *classInfo) const
 Checks whether this object's class is a subclass. More...
 
void move (const IlvPoint &p)
 Moves the graphic object. More...
 
virtual void move (IlvPos x, IlvPos y)
 Moves the graphic object. More...
 
void moveResize (const IlvRect &size)
 Moves and resizes a graphic object. More...
 
virtual IlBoolean needsInputContext () const
 Indicates whether the graphic instance can connect to an input method for locale dependent input. More...
 
virtual void print (std::ostream &out, int level=0) const
 Prints for debugging purposes. More...
 
void removeCallback (const IlSymbol *callbackType, const IlSymbol *callbackName)
 Removes a callback function from a callback list. More...
 
void removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Removes a callback function from a callback list. More...
 
IlBoolean removeClassProperty (const IlSymbol *key)
 Removes a property from this object's class. More...
 
void removeInteractor ()
 Removes the interactor from the current object. More...
 
IlvNamedPropertyremoveNamedProperty (IlSymbol *name)
 Removes a named property from the object. More...
 
IlBoolean removeProperty (const IlSymbol *key)
 Removes a property from the object. More...
 
void removeTag (const IlSymbol *tag)
 Removes a tag. More...
 
IlBoolean replaceClassProperty (const IlSymbol *key, IlAny value)
 Replaces a property in this object's class. More...
 
IlBoolean replaceProperty (const IlSymbol *key, IlAny value)
 Replaces a property. More...
 
virtual void resize (IlvDim newW, IlvDim newH)
 Resizes a graphic object. More...
 
virtual void rotate (const IlvPoint &center, IlFloat angle)
 Rotates a graphic object. More...
 
virtual void scale (IlFloat zoomX, IlFloat zoomY)
 Scales the graphic object. More...
 
void setCallback (const IlSymbol *callbackType, const IlSymbol *callbackName, const IlSymbol *script=0)
 Removes all previously set callbacks. More...
 
void setCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Sets a new callback. More...
 
void setCallback (const IlSymbol *callbackType, IlvGraphicCallback callbackName, IlAny data)
 Removes all previously set callbacks. More...
 
void setCallback (IlvGraphicCallback callback, IlAny data)
 Sets the main callback function. More...
 
void setCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName, IlAny data)
 Sets the callback user data for a callback function. More...
 
void setCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback, IlAny data)
 Sets the callback user data for a callback function. More...
 
void setCallbackName (const IlSymbol *callbackName)
 Sets the symbol that identifies the main callback. More...
 
void setClientData (IlAny clientData)
 Sets client data. More...
 
void setFirstFocusGraphic ()
 Sets the object to be first in the focus chain.
 
void setFocusable (IlBoolean value)
 Set the focusable state of the object. More...
 
IlBoolean setInteractor (const char *name)
 Attaches an interactor to this graphic object. More...
 
IlBoolean setInteractor (IlvInteractor *inter)
 Attaches an interactor to the current object. More...
 
void setLastFocusGraphic ()
 Sets the object to be last in the focus chain.
 
virtual void setName (const char *name)
 Sets the name of the object. More...
 
IlvNamedPropertysetNamedProperty (IlvNamedProperty *property)
 Sets a named property on the object. More...
 
virtual void setNeedsInputContext (IlBoolean val)
 Specifies whether the graphic object should have locale dependent input. More...
 
void setNextFocusGraphic (IlSymbol *name)
 Sets the object to be next in the focus chain. More...
 
void setPreviousFocusGraphic (IlSymbol *name)
 Sets an object as previous in the focus chain. More...
 
void setProperty (const IlSymbol *key, IlAny value)
 Sets a property of the object to a value. More...
 
virtual void setSensitive (IlBoolean value)
 Sets the sensitivity of the object. More...
 
virtual void symmetry (IlvDirection axis)
 Flips a graphic object. More...
 
virtual void translate (IlvPos dx, IlvPos dy)
 Applies a transformation function on a graphic object. More...
 
IlvDim w () const
 Gets the width value of the object. More...
 
void w (IlvDim w)
 Sets the width value of the object. More...
 
virtual void write (IlvOutputFile &output) const =0
 Writes an object description to a file. More...
 
IlvPos x () const
 Gets the x coordinate value of the object. More...
 
void x (IlvPos x)
 Sets the x coordinate value of the object. More...
 
IlvPos y () const
 Gets the y coordinate value of the object. More...
 
void y (IlvPos y)
 Sets the y coordinate value of the object. More...
 
virtual IlBoolean zoomable () const
 Checks whether this object is zoomable. More...
 
- Public Member Functions inherited from IlvValueInterface
virtual IlBoolean applyValue (const IlvValue &value)
 Apply an accessor. More...
 
virtual IlBoolean changeValue (const IlvValue &val)
 Changes the value of an accessor. More...
 
virtual IlBoolean changeValues (const IlvValue *values, IlUShort count=0)
 Changes several accessor values simultaneously. More...
 
virtual IlvValuequeryValue (IlvValue &val) const
 Retrieves an accessor value. More...
 
virtual void queryValues (IlvValue *values, IlUShort count) const
 Retrieves multiple accessor values simultaneously. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvGraphic
static void AddProperty (const IlSymbol *key, IlAny value)
 Adds a property to this object's class. More...
 
static void AddToCallbackTypeList (IlUInt &count, const char *const **names, const IlSymbol *const **types, const char *newName, const IlSymbol *newType)
 Adds a callback to a list. More...
 
static void AllowZoom (IlBoolean az)
 Sets or inhibits zooming. More...
 
static IlvClassInfoClassInfo () const
 Gets class information. More...
 
static IlAny GetProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
 Retrieves the property value associated with the key in this object's class. More...
 
static const IlvClassInfoHasProperty (const IlSymbol *key, IlBoolean checkSuperClass=IlFalse)
 Checks for the existence of a property for this object's class hierarchy. More...
 
static IlBoolean IsZoomAllowed ()
 Checks whether zoomable objects can display themselves when zooming out. More...
 
static IlvGraphicread (IlvInputFile &file, IlvPalette *palette)
 Reads an object description from a file. More...
 
static IlBoolean RemoveProperty (const IlSymbol *key)
 Removes a property from this object's class. More...
 
static IlBoolean ReplaceProperty (const IlSymbol *key, IlAny value)
 Replaces a property in this object's class. More...
 

Detailed Description

Scale class.

Library: views

IlvScale is an abstract class from which are derived all instances of scale object classes. This class manages the basic required information concerning scales.

See also
IlvCircularScale, IlvRectangularScale.

Accessors\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\n\nThis class inherits the accessors of its superclass \c IlvSimpleGraphic and adds the following ones:

Name Type Equivalent methods
steps UInt getSteps(), setSteps()
subSteps UInt getSubSteps(), setSubSteps()
stepSize UInt getStepSize(), setStepSize()
subStepSize UInt getSubStepSize(), setSubStepSize()
min Float getMin(), setMin()
max Float getMax(), setMax()
format String getFormat(), setFormat()

Constructor & Destructor Documentation

◆ IlvScale() [1/2]

IlvScale::IlvScale ( IlvDisplay display,
const IlvRect drawrect,
const char *  format = 0,
IlFloat  min = 0,
IlFloat  max = 100,
IlUShort  steps = 0,
IlUShort  substeps = 0,
IlUShort  stepsize = 10,
IlUShort  substepsize = 5,
IlvPalette palette = 0 
)

Constructor.

This constructor lets you specify a printf() format, to be used when displaying labels. You can specify a 0 value if you don't want any text. You must provide a minimum and a maximum value in min and max.

Parameters
displayThe display where this object is created.
drawrectThe location and size of the scale.
formatThe printf() format of the step labels.
minThe minimum value of the scale.
maxThe maximum value of the scale.
stepsThe number of major ticks to be drawn, which can be 0 for no scales.
substepsThe number of minor ticks displayed between major ones.
stepsizeThe major tick mark size.
substepsizeThe minor tick mark size.
paletteThe palette associated with this object.

◆ IlvScale() [2/2]

IlvScale::IlvScale ( IlvDisplay display,
const IlvRect drawrect,
char *  labels[],
IlUShort  steps = 2,
IlUShort  substeps = 0,
IlUShort  stepsize = 10,
IlUShort  substepsize = 5,
IlvPalette palette = 0 
)

Constructor.

This constructor takes an array of text strings to be displayed. There must be at least as many strings as the number of main scales indicated in the steps parameter.

Parameters
displayThe display where this object is created.
drawrectThe location and size of the scale.
labelsThe array of text strings. The strings are copied.
stepsThe number of major ticks to be drawn, which can be 0 for no scales.
substepsThe number of minor ticks displayed between major ones.
stepsizeThe major tick mark size.
substepsizeThe minor tick mark size.
paletteThe palette associated with this object.

Member Function Documentation

◆ applyTransform()

virtual void IlvScale::applyTransform ( const IlvTransformer t)
virtual

Applies a transformation function to the graphic object.

Applies the transformer t to the shape of the object. Unless the transformation is a scaling operation, the result of applying it to certain objects can be insignificant. For example, applying a non-scaling transformer to an IlvRectangle object is meaningless, since the rectangle remains a rectangle. On the other hand, meaningful transformations can be applied to objects that are instances of types such as IlvLine or IlvPolyPoints.

Note
applyTransform() is one of the most important method to be rewritten for classes derived from IlvGraphic, since it is called by the resize(), move(), moveResize(), scale(), etc., methods.
Parameters
tThe transformer value. If 0, no transformation is performed.

Implements IlvGraphic.

Reimplemented in IlvRectangularScale, and IlvCircularScale.

◆ boundingBox()

virtual void IlvScale::boundingBox ( IlvRect bbox,
const IlvTransformer t = 0 
) const
pure virtual

Retrieves the bounding box of the graphic object.

Sets bbox, the rectangle reference parameter, to be the bounding box of the object. Since the object can appear within a transformed environment (for example, in a multiview editor), an IlvTransformer object occurs as an optional parameter in order to compute the bounding box in the coordinate system of the transformed environment.

Parameters
bboxThe bounding box to be set.
tA transformer value or 0 if there is no transformation.

Implements IlvGraphic.

Implemented in IlvRectangularScale, and IlvCircularScale.

◆ draw()

virtual void IlvScale::draw ( IlvPort dst,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const
pure virtual

Draws the graphic object.

Draws the object in the given IlvPort using the transformer t.

Parameters
dstThe destination port this object is drawn onto.
tThe transformer value. If 0, no transformation is performed.
clipThe clipping region, relative to the transformed object, or 0 if none.

Implements IlvGraphic.

Implemented in IlvRectangularScale, and IlvCircularScale.

◆ getFormat()

const char* IlvScale::getFormat ( ) const

Gets the format of the step labels.

Returns
The format of the step labels, if you have used the first constructor, which allows you to create a scale with numerical labels. The formats are the same as those used with printf().

◆ getLabel()

const char* IlvScale::getLabel ( IlUShort  idx) const

Gets a label.

Parameters
idxThe index of the label to retrieve.
Returns
The idx th label of this scale. This value must not be deleted nor modified by the user.

◆ getLabels()

char* const* IlvScale::getLabels ( ) const

Gets the labels.

Returns
The array of character strings displayed beside the major scales.

◆ getLabelSizes()

void IlvScale::getLabelSizes ( IlUShort  idx,
IlvDim w,
IlvDim h,
IlvDim d 
) const

Gets a label's sizes.

Parameters
idxThe index of the step label to query.
wIs set to the label's width.
hIs set to the label's height.
dIs set to the label's descent value.

◆ getMax()

IlFloat IlvScale::getMax ( ) const

Gets the maximum value of the scale.

Returns
The maximum value of the scale, if you have used the first constructor, which allows you to create a scale with numerical labels.

◆ getMin()

IlFloat IlvScale::getMin ( ) const

Gets the minimum value of the scale.

Returns
The minimum value of the scale, if you have used the first constructor, which allows you to create a scale with numerical labels.

◆ getSteps()

IlUShort IlvScale::getSteps ( ) const

Gets the number of steps.

Returns
The number of major steps (ticks) for this object.

◆ getStepSize()

IlUShort IlvScale::getStepSize ( ) const

Gets the step size.

Returns
The size of the major tick marks.

◆ getSubSteps()

IlUShort IlvScale::getSubSteps ( ) const

Gets the number of substeps.

Returns
The number of minor steps (ticks) for this object.

◆ getSubStepSize()

IlUShort IlvScale::getSubStepSize ( ) const

Gets the substep size.

Returns
The size of the minor tick marks.

◆ setFont()

virtual void IlvScale::setFont ( IlvFont font)
virtual

Sets the font of the object.

Parameters
fontThe new font.

Reimplemented from IlvSimpleGraphic.

◆ setFormat()

void IlvScale::setFormat ( const char *  format)

Sets the format of the step labels.

The formats are the same as those used with printf(). Note that if the scale was previously using text labels, they are replaced by numerical labels.

Parameters
formatThe printf() format of the step labels.

◆ setLabel()

void IlvScale::setLabel ( IlUShort  idx,
const char *  label 
)

Sets a label.

Sets the idx th label by creating a copy of the label parameter.

Parameters
idxThe index of the label to be set.
labelThe label string. This string in copied.

◆ setLabels() [1/2]

void IlvScale::setLabels ( IlUShort  count,
const char *const *  labels = 0 
)

Sets the labels.

This member function changes the array of character strings displayed beside the major ticks to the values provided in the labels parameter.

Parameters
countThe number of labels stored in labels. This number must match the number of tick marks for this scale object.
labelsThe array of text strings. The array is copied internally. If set to 0, no labels are displayed on the tick marks.

◆ setLabels() [2/2]

void IlvScale::setLabels ( IlUShort  count,
IlFloat  min,
IlFloat  max,
const char *  format 
)

Sets the labels.

Computes a new array of character strings displayed beside the major scales. These new strings are computed by creating a string representation of a value that goes from min to max, using the format string format as in printf(). For example:

scale->setLabels(11, 0., 10., "%.2f");

This code creates and stores 11 labels: "0.00", "1.00" to "10.00".
The min value is assigned to the first tick mark and the max value to the last one. max does not have to be greater than min.

Parameters
countThe number of labels.
minThe value assigned to the first tick mark.
maxThe value assigned to the last tick mark.
formatThe printf() format of the step labels.

◆ setMax()

void IlvScale::setMax ( IlFloat  max)

Sets the maximum value of the scale.

Note that if the scale was previously using text labels, they are replaced by numerical labels.

Parameters
maxThe maximum value of the scale.

◆ setMin()

void IlvScale::setMin ( IlFloat  min)

Sets the minimum value of the scale.

Note that if the scale was previously using text labels, they are replaced by numerical labels.

Parameters
minThe minimum value of the scale.

◆ setPalette()

virtual void IlvScale::setPalette ( IlvPalette palette)
virtual

Sets the internal palette.

The previous palette is unlocked, and palette is locked.

Parameters
paletteThe new palette of this object.

Reimplemented from IlvSimpleGraphic.

◆ setSteps()

void IlvScale::setSteps ( IlUShort  steps)

Sets the number of steps.

Sets the number of major steps (ticks) in this scale to steps.

Parameters
stepsThe number of major ticks to be drawn, which can be 0 for no scales.

◆ setStepSize()

void IlvScale::setStepSize ( IlUShort  stepsize)

Sets the step size.

Sets the value of the stepsize parameter as the size of the major tick marks.

Parameters
stepsizeThe major tick mark size.

◆ setSubSteps()

void IlvScale::setSubSteps ( IlUShort  substeps)

Sets the number of substeps.

Sets the number of minor steps (ticks) in this scale to substeps.

Parameters
substepsThe number of minor ticks displayed between major ones.

◆ setSubStepSize()

void IlvScale::setSubStepSize ( IlUShort  substepsize)

Sets the substep size.

Sets the value of the substepsize parameter as the size of the minor tick marks.

Parameters
substepsizeThe minor tick mark size.
IlvGraphic::scale
virtual void scale(IlFloat zoomX, IlFloat zoomY)
Scales the graphic object.