rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvGraphicSet Class Reference

Graphic class. More...

#include <ilviews/graphics/set.h>

Inheritance diagram for IlvGraphicSet:
IlvGraphic IlvSelector

Public Member Functions

 IlvGraphicSet ()
 Constructor. More...
 
 IlvGraphicSet (int num...)
 Constructor. More...
 
 ~IlvGraphicSet ()
 Destructor. More...
 
virtual void addObject (IlvGraphic *obj)
 Adds an object. More...
 
void align (IlvPosition align=IlvLeft)
 Aligns the objects. More...
 
virtual void apply (IlvApplyObject function, IlAny arg)
 Applies a function to the objects. More...
 
virtual void applyReferences (IlvApplyObject function, IlAny arg)
 Applies a function to the referenced objects. More...
 
virtual void applyTransform (const IlvTransformer *t)
 Applies a transformation function to the graphic object. More...
 
virtual void boundingBox (IlvRect &r, const IlvTransformer *t=0) const
 Retrieves the bounding box of the graphic object. More...
 
void column (IlvDeltaPos spacing=4)
 Force a vertical space between the objects. 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 void draw (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws the graphic object. More...
 
IlvGraphicfirstContains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
 Gets an object at a given location. More...
 
IlvGraphicfirstIntersects (const IlvRegion &region, const IlvTransformer *t=0) const
 Gets an object in a given region. More...
 
virtual IlvIntensity getAlpha () const
 Retrieves the alpha component. More...
 
IlUInt getCardinal () const
 Gets the number of stored objects. 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 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...
 
IlInt getIndex (IlvGraphic *object) const
 Gets the index of an object. More...
 
virtual IlUShort getLineWidth () const
 Retrieves the line width. More...
 
IlvGraphicgetObject (IlUInt index) const
 Gets an object by index. More...
 
IlvGraphic *const * getObjects (IlUInt &count) const
 Gets an array of all stored objects. More...
 
virtual void insertObject (IlvGraphic *object)
 Inserts an object. More...
 
virtual IlBoolean inside (const IlvRegion &tregion, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
virtual IlBoolean intersects (const IlvRegion &tregion, const IlvTransformer *t=0) const
 Checks whether a region intersects the bounding box with transformation applied. More...
 
virtual void invert (IlBoolean=IlFalse)
 Highlights the object. More...
 
virtual void print (ILVSTDPREF ostream &, int level=0) const
 Prints for debugging purposes. More...
 
virtual void removeObject (IlvGraphic *object)
 Removes an object. More...
 
void row (IlvDeltaPos spacing=4)
 Force an horizontal space between the objects. More...
 
void sameHeight (IlvDim height)
 Force the height of all the objects. More...
 
void sameWidth (IlvDim width)
 Force the width of all the objects. 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 setFont (IlvFont *)
 Sets the font of the object. 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 *holder)
 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...
 
void setObject (IlUInt index, IlvGraphic *object)
 Sets an object. More...
 
virtual void setOverwrite (IlBoolean)
 Sets an overwrite mode that modifies how the drawing member functions operate. More...
 
virtual void setPalette (IlvPalette *)
 Sets the palette of the object. More...
 
virtual void setPattern (IlvPattern *)
 Sets the pattern of the object. More...
 
virtual void symmetry (IlvDirection)
 Flips a graphic object. More...
 
virtual IlBoolean zoomable () const
 Checks whether this object is zoomable. More...
 
- Public Member Functions inherited from IlvGraphic
void addCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Adds a callback function to a callback list. More...
 
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, 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...
 
IlBoolean applyAttribute (const char *attributeClassName, IlInt 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, const char *value, IlAny checkData=0) const
 Applies attributes. More...
 
virtual void applyResources (const char *storageName, const char *storageClassName, const char *objectName, const char *objectClassName, IlvDisplay *display=0)
 Applies resources on a graphic object. More...
 
virtual IlBoolean applyValue (const IlvValue &val)
 Apply an accessor. More...
 
virtual void callCallbacks (const IlSymbol *callbackType)
 Calls every callback of a given type. More...
 
virtual IlBoolean changeValue (const IlvValue &val)
 Changes the value of an accessor. More...
 
virtual IlBoolean changeValues (const IlvValue *values, IlUShort count)
 Changes several accessor values simultaneously. 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 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 **accessors, const IlvValueTypeClass *const **types, IlUInt &count) const
 Retrieves the list of available accessors of an object. More...
 
virtual IlvAntialiasingMode getAntialiasingMode () const
 Retrieves the anti-aliasing mode. More...
 
IlvGraphicCallback getCallback (const IlSymbol *callbackType) const
 Gets a callback. More...
 
IlvGraphicCallback getCallback () const
 Gets the main callback function. More...
 
IlAny getCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Gets a callback user data. More...
 
IlAny getCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Gets a callback user data. More...
 
IlSymbolgetCallbackName (const IlSymbol *callbackType) const
 Gets the name of a callback. More...
 
IlSymbolgetCallbackName () const
 Gets the symbol that identifies the main 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 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...
 
virtual IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look & feel handler used by this 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 a specified graphic 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, IlvGraphicCallback callback) const
 Checks whether a callback function is in a callback list. More...
 
IlBoolean hasCallback (const IlSymbol *callbackType, const IlSymbol *callbackName) const
 Checks whether a callback function is in a callback list. More...
 
IlBoolean hasCallbackData (const IlSymbol *callbackType, IlvGraphicCallback callback) const
 Checks whether a callback function has user data. More...
 
IlBoolean hasCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName) 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 IlvRect &tr, const IlvTransformer *t=0) const
 Determines whether an object with transformation applied is inside the bounding box. More...
 
IlBoolean inside (const IlvRect &r) const
 Determines whether a rectangle is inside 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...
 
IlBoolean intersects (const IlvRect &r) const
 Checks whether a rectangle intersects the bounding box. 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 or not. 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...
 
virtual void move (IlvPos x, IlvPos y)
 Moves the graphic object. More...
 
void move (const IlvPoint &p)
 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 IlvValuequeryValue (IlvValue &val) const
 Retrieves the value of an accessor. More...
 
virtual void queryValues (IlvValue *values, IlUShort count) const
 Retrieves multiple accessor values simultaneously. More...
 
void removeCallback (const IlSymbol *callbackType, IlvGraphicCallback callback)
 Removes a callback function from a callback list. More...
 
void removeCallback (const IlSymbol *callbackType, const IlSymbol *callbackName)
 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, IlvGraphicCallback callback)
 Sets a new callback. 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, 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, IlvGraphicCallback callback, IlAny data)
 Sets the callback user data for a callback function. More...
 
void setCallbackData (const IlSymbol *callbackType, const IlSymbol *callbackName, 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 (IlvInteractor *inter)
 Attaches an interactor to the current object. More...
 
IlBoolean setInteractor (const char *name)
 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 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...
 

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

Graphic class.

Library: views

An IlvGraphicSet object organizes a set of IlvGraphic objects. IlvGraphicSet implements all geometric and graphic member functions by means of calls to the member functions of the objects that it contains. For example, the draw method of IlvGraphicSet calls the draw method of the objects contained in the graphic set.

- IlvGraphicSet -

See Also
IlvManager::group, IlvManager::unGroup.

Constructor & Destructor Documentation

IlvGraphicSet::IlvGraphicSet ( )

Constructor.

Initializes an empty IlvGraphicSet object, which is a skeleton. You can call member functions such as addObject to add IlvGraphic objects to the IlvGraphicSet object.

IlvGraphicSet::IlvGraphicSet ( int  num...)

Constructor.

Initializes an IlvGraphicSet object on the basis of the nObjects parameter. IlvGraphic objects are provided as the parameters following num.

Parameters
numThe number of initial objects in this new graphic set. This should also be the number of parameters that follow num, and all must be pointers to valid instances of IlvGraphic.
IlvGraphicSet::~IlvGraphicSet ( )

Destructor.

The destructor destroys all the objects that are stored in this graphic set.

Member Function Documentation

virtual void IlvGraphicSet::addObject ( IlvGraphic obj)
virtual

Adds an object.

Adds an object at the end of the objects list, so it will be the last to be drawn.

Warning
[note] Although it is possible to add an object twice to the object list, it is not recommended.
void IlvGraphicSet::align ( IlvPosition  align = IlvLeft)

Aligns the objects.

Applies an alignment to all objects, relatively to the global bounding box of the graphic set.

Parameters
alignThe direction of the alignment. This can be either IlvLeft, IlvTop, IlvRight, or IlvBottom to translate all the objects so that they share the indicated side coordinate. This parameter can also be set to IlvHorizontalCenter, IlvVerticalCenter, or IlvCenter to align the indicated positions.
virtual void IlvGraphicSet::apply ( IlvApplyObject  function,
IlAny  arg 
)
virtual

Applies a function to the objects.

Applies a function to all the IlvGraphic objects that are referenced. The function function will be called for each object stored in this set. The function will receive, in turn, a pointer to each of the objects that are stored in the set and a user-defined parameter.

Parameters
functionThe function to be applied to the objects.
argThe user argument that will be provided to function for each object.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::applyReferences ( IlvApplyObject  function,
IlAny  arg 
)
virtual

Applies a function to the referenced objects.

Calls the member function IlvGraphic::applyReferences with the arguments function and argument for each object stored in the set.

Parameters
functionThe function to be applied to the referenced objects.
argThe user argument that will be provided to function for each object.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::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.

Warning
[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.

virtual void IlvGraphicSet::boundingBox ( IlvRect bbox,
const IlvTransformer t = 0 
) const
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. When there is no transformation, t is set to 0.

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

Implements IlvGraphic.

void IlvGraphicSet::column ( IlvDeltaPos  spacing = 4)

Force a vertical space between the objects.

Moves the objects vertically to set a constant vertical space between them. The method does not align the objects.

Parameters
spacingThe vertical space that is set between two consecutive objects.
virtual IlBoolean IlvGraphicSet::contains ( const IlvPoint p,
const IlvPoint tp,
const IlvTransformer t = 0 
) const
virtual

Checks whether a point is in the object.

Checks whether the coordinates are located in the shape of this object. A transformation parameter allows you to use the view's coordinate system for this test.

Parameters
pThe point to be tested.
tpThe transformed point obtained by applying the transformer t to the point p.
tA transformer value, or 0 if there is no transformation.
Returns
IlTrue when the point p lies inside the outline of the object.

Reimplemented from IlvGraphic.

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

Draws the graphic object.

Draws the object in the given IlvPort using the transformer t which might have the value 0. The clip parameter, which can also be 0, represents the clipping region relative to the transformed object.

Parameters
dstThe destination port.
tThe transformer value. If 0, no transformation is performed.
clipThe clipping region, or 0 if none.

Implements IlvGraphic.

IlvGraphic* IlvGraphicSet::firstContains ( const IlvPoint p,
const IlvPoint tp,
const IlvTransformer t = 0 
) const

Gets an object at a given location.

Parameters
pThe point, in the graphic set coordinates system that is looked at.
tpThe point, in the coordinates system defined by t that is looked at.
tThe transformation that is used for the seek.
Returns
A pointer to the first object located at p, or 0 if there are none. The tp parameter is the transformed point obtained by applying the transformer t to the point p. This allows you to use the view coordinates system for this test.
IlvGraphic* IlvGraphicSet::firstIntersects ( const IlvRegion region,
const IlvTransformer t = 0 
) const

Gets an object in a given region.

Parameters
regionThe region where objects are searched. This region is in the coordinates system defined by t.
Returns
A pointer to the first object that intersects with the region region, or 0 if there are none.
virtual IlvIntensity IlvGraphicSet::getAlpha ( ) const
virtual

Retrieves the alpha component.

Returns
The alpha component of the object.

Reimplemented from IlvGraphic.

IlUInt IlvGraphicSet::getCardinal ( ) const

Gets the number of stored objects.

Returns
The total number of objects stored in this set.
virtual IlvGraphic* IlvGraphicSet::getChildAt ( IlUInt  index) const
virtual

Returns the sub-object of the graphic object specified by index.

Parameters
indexThe index of the object being searched.
Returns
The sub-object of the graphic object with index index. If the index is not valid, 0 is returned.

Reimplemented from IlvGraphic.

virtual IlvGraphic* IlvGraphicSet::getChildByName ( const char *  name) const
virtual

Returns the sub-object of the graphic object specified by name.

Parameters
nameThe name of the object being searched.
Returns
The sub-object of the graphic object whose name is name. If this graphic object does not contain a sub-object with name as name, 0 is returned.

Reimplemented from IlvGraphic.

virtual IlUInt IlvGraphicSet::getChildCount ( ) const
virtual

Returns the number of children of this graphic object.

Returns
The number of children of this graphic object.

Reimplemented from IlvGraphic.

virtual IlInt IlvGraphicSet::getChildIndex ( const IlvGraphic object) const
virtual

Returns the index of the specified sub-object in this graphic object.

Parameters
objectThe sub-object whose index is being searched for.
Returns
The index of the sub-object in this graphic object, or -1 if object is not a sub-object of this graphic object.

Reimplemented from IlvGraphic.

IlInt IlvGraphicSet::getIndex ( IlvGraphic object) const

Gets the index of an object.

Parameters
objectThe object that is seeked.
Returns
The index of the object in this set. The first object of the set has an index of 0. If the object is not stored in this set, this function returns -1.
virtual IlUShort IlvGraphicSet::getLineWidth ( ) const
virtual

Retrieves the line width.

Returns
The line width of the object.

Reimplemented from IlvGraphic.

IlvGraphic* IlvGraphicSet::getObject ( IlUInt  index) const

Gets an object by index.

Parameters
indexThe index of the object that is seeked.
Returns
The index th object. The first object of the set has an index of 0.
IlvGraphic* const* IlvGraphicSet::getObjects ( IlUInt count) const

Gets an array of all stored objects.

Parameters
countIs set on return to the number of returned objects.
Returns
An array of graphic objects stored in this GraphicSet. This array will have count elements, and must not be modified or deleted. Other Rogue Wave Views functions can overwrite this array so the caller of this method should consider copying it.
virtual void IlvGraphicSet::insertObject ( IlvGraphic object)
virtual

Inserts an object.

Inserts an object at the beginning of the maintained list so it will be the first object to be drawn when the IlvGraphicSet object is redrawn.

Parameters
objectThe object to be inserted.

Reimplemented in IlvSelector.

virtual IlBoolean IlvGraphicSet::inside ( const IlvRegion r,
const IlvTransformer t = 0 
) const
virtual

Determines whether an object with transformation applied is inside the bounding box.

Determines whether an object with transformation applied is inside the bounding box.

Parameters
rThe region to be tested.
tA transformer value, or 0 if there is no transformation.
Returns
IlTrue when the object, drawn with the transformer t, covers completely the region r. This virtual member function returns IlFalse when this is not the case. That means that it returns IlTrue if all rectangles that define the region completely lie inside the object.

Reimplemented from IlvGraphic.

virtual IlBoolean IlvGraphicSet::intersects ( const IlvRegion r,
const IlvTransformer t = 0 
) const
virtual

Checks whether a region intersects the bounding box with transformation applied.

Checks whether a region intersects the bounding box with transformation applied.

Parameters
rThe region to be tested.
tA transformer value, or 0 if there is no transformation.
Returns
IlTrue when the region r overlaps the transformed object (if t is not 0) and IlFalse when this is not the case.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::invert ( IlBoolean  temp = IlFalse)
virtual

Highlights the object.

Highlights the object. It is implemented as swapping the foreground and background colors of the object, but can have other implementations in derived subclasses. The parameter temp controls the way you toggle between the background and the foreground. If temp is omitted or is IlFalse, then a new palette is computed by calling the IlvDisplay::getPalette() method. If temp is IlTrue, the object palette is inverted, and thus all the objects referencing this palette will be affected.

Parameters
tempIf IlTrue, highlights the object.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::print ( ILVSTDPREF ostream &  out,
int  level = 0 
) const
virtual

Prints for debugging purposes.

Use for debugging purposes. Depending on the debugging level given as the level parameter, basic information about this object is printed to out. Basic implementation prints the object class name, and its bounding box. When this object is defined by another object (that is, if it is a referenced object), this subobject is described only if the level parameter is not zero. When this object is defined by a group of objects, these subobjects are defined themselves if the level parameter is not zero. In general, the higher level is, the more information you get about the object.

Parameters
outThe output stream.
levelThe debugging level. If 0, subobjects are not described.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::removeObject ( IlvGraphic object)
virtual

Removes an object.

Removes an object from the list of referenced objects. If an object is stored more than once in the same IlvGraphicSet, only the first occurrence will be removed. The object is not destroyed.

Parameters
objectThe object to be removed from this graphic set.

Reimplemented in IlvSelector.

void IlvGraphicSet::row ( IlvDeltaPos  spacing = 4)

Force an horizontal space between the objects.

Moves the objects horizontally to set a constant horizontal space between them. The method does not align the objects.

Parameters
spacingThe horizontal space that is set between two consecutive objects.
void IlvGraphicSet::sameHeight ( IlvDim  height)

Force the height of all the objects.

Resizes each object according to a given height.

Parameters
heightThe new height of all the stored objects.
void IlvGraphicSet::sameWidth ( IlvDim  width)

Force the width of all the objects.

Resizes each object according to a given width.

Parameters
widthThe new width of all the stored objects.
virtual void IlvGraphicSet::setAlpha ( IlvIntensity  alpha)
virtual

Sets the alpha value of the object.

Parameters
alphaThe new alpha value.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setAntialiasingMode ( IlvAntialiasingMode  mode)
virtual

Sets the anti-aliasing mode of the object.

Parameters
modeThe new anti-aliasing mode.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setArcMode ( IlvArcMode  mode)
virtual

Sets the arc mode of the object.

Parameters
modeThe new arc mode.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setBackground ( IlvColor background)
virtual

Sets the background color of the object.

Sets the background color of the object.

Parameters
backgroundThe new background color.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setColorPattern ( IlvColorPattern pattern)
virtual

Sets the color pattern of the object.

Sets the color pattern of the object.

Parameters
patternThe new color pattern.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setFillRule ( IlvFillRule  rule)
virtual

Sets the fill rule of the object.

Parameters
ruleThe new fill rule.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setFillStyle ( IlvFillStyle  style)
virtual

Sets the fill style of the object.

Parameters
styleThe new fill style.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setFont ( IlvFont font)
virtual

Sets the font of the object.

Parameters
fontThe new font.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setForeground ( IlvColor foreground)
virtual

Sets the foreground color of the object.

Sets the foreground color of the object.

Parameters
foregroundThe new foreground color.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setGradientPattern ( IlvGradientPattern pattern)
virtual

Sets the gradient pattern of the object.

Sets the gradient pattern of the object.

Parameters
patternThe new gradient pattern.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setHolder ( IlvGraphicHolder holder)
virtual

Sets the object's holder.

This default implementation has no real function.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setLineStyle ( IlvLineStyle style)
virtual

Sets the line style of the object.

Parameters
styleThe new line style.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setLineWidth ( IlUShort  width)
virtual

Sets the line width of the object.

Parameters
widthThe new line width.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setMode ( IlvDrawMode  mode)
virtual

Sets the drawing mode of the object temporarily.

Changing the IlvDrawMode attribute of an object is considered a temporary operation. You have to set the mode to its default value when you no longer need another mode different from the value IlvModeSet. The drawing mode information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite method for more details).

Parameters
modeThe drawing mode to be set.

Reimplemented from IlvGraphic.

void IlvGraphicSet::setObject ( IlUInt  index,
IlvGraphic object 
)

Sets an object.

Changes the index th object of this set so it becomes object. If index is invalid, this function does nothing. The previous object is destroyed.

Parameters
indexThe index of the object that is replaced.
objectThe new object that is stored.
virtual void IlvGraphicSet::setOverwrite ( IlBoolean  over)
virtual

Sets an overwrite mode that modifies how the drawing member functions operate.

Modifies the way the drawing member functions operate. The information is passed to the palette of the graphic object (see the IlvPalette::setOverwrite method for more details).

Parameters
overIf IlFalse, sets selective hidden drawing operations.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setPalette ( IlvPalette palette)
virtual

Sets the palette of the object.

Each of the graphic properties of this object is then taken from this IlvPalette instance.

Parameters
paletteThe palette to be set.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::setPattern ( IlvPattern pattern)
virtual

Sets the pattern of the object.

Sets the pattern of the object.

Parameters
patternThe new pattern.

Reimplemented from IlvGraphic.

virtual void IlvGraphicSet::symmetry ( IlvDirection  axis)
virtual

Flips a graphic object.

Flips the object about one of the horizontal or vertical axis (or a combination of the two). The axis is given by the axis parameter, which you can give the value IlvHorizontal, in

which case the flip takes place around the horizontal axis of the object, or IlvVertical, which flips the object around the

vertical axis. You can also use the IlvCenter value to flip the object around its center. The default implementation calls the member function applyTransform with a transformer corresponding to the required symmetry.

Parameters
axisThe axis around which flipping occurs.

Reimplemented from IlvGraphic.

virtual IlBoolean IlvGraphicSet::zoomable ( ) const
virtual

Checks whether this object is zoomable.

Returns
IlTrue if the graphic object can be zoomed, and IlFalse otherwise. See the member functions IsZoomAllowed and AllowZoom below.

Reimplemented from IlvGraphic.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.