rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvOutlinePolygon Class Reference

Graphic class. More...

#include <ilviews/graphics/outpoly.h>

Inheritance diagram for IlvOutlinePolygon:
IlvPolygon IlvPolyline IlvPolyPoints IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvOutlinePolygon (IlvDisplay *display, IlUInt count, IlvPoint *points, IlvPalette *palette=0)
 Constructor.
const char * className () const
 Returns the class name of an object.
virtual IlvGraphiccopy () const
 Copies this object.
virtual void draw (IlvPort *, const IlvTransformer *t=0, const IlvRegion *clip=0) const
 Draws the graphic object.
virtual IlvClassInfogetClassInfo () const
 Gets class information.
virtual void invert (IlBoolean)
 Highlights the object.
IlBoolean isSubtypeOf (const IlvClassInfo *c) const
 Checks whether this object's class is a subclass.
IlBoolean isSubtypeOf (const char *t) const
 Checks whether this object's class is a subclass of a given parent class.
virtual void setAlpha (IlvIntensity)
 Sets the alpha value of the object.
virtual void setAntialiasingMode (IlvAntialiasingMode)
 Sets the anti-aliasing mode of the object.
virtual void setBackground (IlvColor *)
 Sets the background color of the object.
virtual void setForeground (IlvColor *)
 Sets the foreground color of the object.
virtual void setLineStyle (IlvLineStyle *)
 Sets the line style of the object.
virtual void setLineWidth (IlUShort)
 Sets the line width of the object.
virtual void setMode (IlvDrawMode)
 Sets the drawing mode of the object temporarily.
virtual void setOverwrite (IlBoolean)
 Sets an overwrite mode that modifies how the drawing member functions operate.
virtual void setPalette (IlvPalette *)
 Sets the internal palette to the given palette value.

Static Public Member Functions

static void AddProperty (const IlSymbol *k, IlAny v)
 Adds a property to this object's class.
static IlAny GetProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
 Retrieves the property value associated with the key in this object's class.
static const IlvClassInfoHasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
 Checks for the existence of a property for this object's class hierarchy.
static IlvGraphicread (IlvInputFile &, IlvPalette *pal)
 Reads an object description from a file.
static IlBoolean RemoveProperty (const IlSymbol *key)
 Removes a property from this object's class.
static IlBoolean ReplaceProperty (const IlSymbol *k, IlAny v)
 Replaces a property in this object's class.

Detailed Description

Graphic class.

Library: views

An IlvOutlinePolygon object appears as an outlined and filled polygon. The rule used to decide polygon filling in ambiguous regions is provided by the IlvFillRule attribute of the object's palette. See the IlvPalette::getFillRule and IlvPalette::setFillRule member functions.

outlpgon.gif


- IlvOutlinePolygon -


Constructor & Destructor Documentation

IlvOutlinePolygon::IlvOutlinePolygon ( IlvDisplay display,
IlUInt  count,
IlvPoint points,
IlvPalette palette = 0 
)

Constructor.

Initializes an IlvOutlinePolygon graphic object from an array of points.

Parameters:
display The display instance.
count The number of points in the array.
points The array of points. The array is copied.
palette The palette used to draw the graphic object.

Member Function Documentation

static void IlvOutlinePolygon::AddProperty ( const IlSymbol key,
IlAny  value 
) [static]

Adds a property to this object's class.

This static function associates the given value with the given key for the class of this object only.

Parameters:
key The key to be associated.
value The value to be associated.

Reimplemented from IlvPolygon.

const char* IlvOutlinePolygon::className (  )  const

Returns the class name of an object.

This method is equivalent to getClassInfo()->getClassName().

Returns:
The class name of the object. For example, for an IlvRectangle object, the className function returns "IlvRectangle".

Reimplemented from IlvPolygon.

virtual IlvGraphic* IlvOutlinePolygon::copy (  )  const [virtual]

Copies this object.

Allocates and returns a copy of this object. If the object is composite, the implementation of this member function makes a copy of the object's components.

Returns:
A copy of the object.
See also:
IlvPredefinedIOMembers.

Reimplemented from IlvPolygon.

virtual void IlvOutlinePolygon::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:
dst The destination port.
t The transformer value. If 0, no transformation is performed.
clip The clipping region, or 0 if none.

Reimplemented from IlvPolygon.

virtual IlvClassInfo* IlvOutlinePolygon::getClassInfo (  )  const [virtual]

Gets class information.

Returns a pointer to the IlvClassInfo object associated with this object's class.

Returns:
A pointer to the class information object of the class of this object.

Reimplemented from IlvPolygon.

static IlAny IlvOutlinePolygon::GetProperty ( const IlSymbol key,
IlBoolean  checkSuperClass = ((IlBoolean) 0) 
) [static]

Retrieves the property value associated with the key in this object's class.

Retrieves the property value associated with the property name key. If the property cannot be found in the class of this object, and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until the property is found. If the property cannot be found, then 0 is returned.

Parameters:
key The key with which the property value is associated.
checkSuperClass IlTrue specifies iterative search on superclasses.
Returns:
The property value associated with the proper name key, or 0.

Reimplemented from IlvPolygon.

static const IlvClassInfo* IlvOutlinePolygon::HasProperty ( const IlSymbol key,
IlBoolean  checkSuperClass = ((IlBoolean) 0) 
) [static]

Checks for the existence of a property for this object's class hierarchy.

Retrieves a pointer to the IlvClassInfo that indicates a class where the key property exists. If the returned value is non-0, then this property actually exists for this class. If this is not the case and if checkSuperClass is set to IlTrue, then the function operates iteratively on each superclass until a match is found. If the property cannot be found, then 0 is returned.

Parameters:
key The key with which the property value is associated.
checkSuperClass IlTrue specifies iterative search on superclasses.
Returns:
A pointer to the ClassInfo that indicates a class where the key property exists, or 0.

Reimplemented from IlvPolygon.

virtual void IlvOutlinePolygon::invert ( IlBoolean  temp  )  [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:
temp If IlTrue, highlights the object.

Reimplemented from IlvSimpleGraphic.

IlBoolean IlvOutlinePolygon::isSubtypeOf ( const IlvClassInfo classInfo  )  const

Checks whether this object's class is a subclass.

This method is equivalent to getClassInfo()->isSubtypeOf(classInfo).

Parameters:
classInfo The name of a class on which the object's class is tested.
Returns:
Either IlTrue or IlFalse, depending on whether or not this object's class is a subclass of the class indicated by classInfo.

Reimplemented from IlvPolygon.

IlBoolean IlvOutlinePolygon::isSubtypeOf ( const char *  parentClass  )  const

Checks whether this object's class is a subclass of a given parent class.

This method is equivalent to getClassInfo()->isSubtypeOf(parentClass).

Parameters:
parentClass A string representing the parent class.
Returns:
Either IlTrue or IlFalse, depending on whether or not this object's class inherits parentClass attributes. The parentClass parameter should be a string representing the class name of an IlvGraphic subclass. A call to this member function for a given class instance returns IlTrue if given the name of its class.

Reimplemented from IlvPolygon.

static IlvGraphic* IlvOutlinePolygon::read ( IlvInputFile file,
IlvPalette palette 
) [static]

Reads an object description from a file.

Reads an object description from the file input, given the palette graphic attributes. It reads the information that was saved by the member function write to be able to create a new instance of this object. Usually, because of the availability of the constructor that expects an IlvInputFile, read should be equivalent to:

 IlvGraphic*
 MyClass::read(IlvInputFile& file, IlvPalette* palette)
 {
     return new MyClass(file, palette);
 }

In the following example, the static member function read of the IlvLabel class could have the following form:

 IlvGraphic*
 IlvLabel::read(IlvInputFile& file, IlvPalette* pal)
 {
     IlvPoint pos;
     file.getStream() >> pos;     // Read the position field
     return new IlvLabel(pal->getDisplay(), pos,
     IlvReadString(file.getStream()), pal);
 }
Parameters:
file The name of the file to be read from.
palette The name of the palette for the object.
See also:
DeclareTypeInfoRO, DeclareTypeInfo, IlvPredefinedIOMembers.
Warning:
[note] The read method is not capitalized like other static methods so that it is consistent with the write method.

Reimplemented from IlvPolygon.

static IlBoolean IlvOutlinePolygon::RemoveProperty ( const IlSymbol key  )  [static]

Removes a property from this object's class.

This static function removes the indicated property to the class of this object.

Parameters:
key The key property to be removed.
Returns:
IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvPolygon.

static IlBoolean IlvOutlinePolygon::ReplaceProperty ( const IlSymbol key,
IlAny  value 
) [static]

Replaces a property in this object's class.

This static function replaces the indicated property value to the class of this object.

Parameters:
key The key to be replaced.
value The value to be replaced.
Returns:
IlTrue if the key property was actually found, or IlFalse otherwise.

Reimplemented from IlvPolygon.

virtual void IlvOutlinePolygon::setAlpha ( IlvIntensity  alpha  )  [virtual]

Sets the alpha value of the object.

Parameters:
alpha The new alpha value.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::setAntialiasingMode ( IlvAntialiasingMode  mode  )  [virtual]

Sets the anti-aliasing mode of the object.

Parameters:
mode The new anti-aliasing mode.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::setBackground ( IlvColor background  )  [virtual]

Sets the background color of the object.

Sets the background color of the object.

Parameters:
background The new background color.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::setForeground ( IlvColor foreground  )  [virtual]

Sets the foreground color of the object.

Sets the foreground color of the object.

Parameters:
foreground The new foreground color.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::setLineStyle ( IlvLineStyle style  )  [virtual]

Sets the line style of the object.

Parameters:
style The new line style.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::setLineWidth ( IlUShort  width  )  [virtual]

Sets the line width of the object.

Parameters:
width The new line width.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::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:
mode The drawing mode to be set.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::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:
over If IlFalse, sets selective hidden drawing operations.

Reimplemented from IlvSimpleGraphic.

virtual void IlvOutlinePolygon::setPalette ( IlvPalette palette  )  [virtual]

Sets the internal palette to the given palette value.

Sets the internal palette to the given palette value. The previous palette is unlocked, and palette is locked.

Parameters:
palette The new palette of this object.

Reimplemented from IlvSimpleGraphic.


© 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.