rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvClosedSpline Class Reference

Graphic class. More...

#include <ilviews/graphics/spline.h>

Inheritance diagram for IlvClosedSpline:
IlvSpline IlvPolyPoints IlvSimpleGraphic IlvGraphic IlvFilledSpline

List of all members.

Public Member Functions

 IlvClosedSpline (IlvDisplay *display, const IlvRect &ellipse, IlvPalette *palette=0)
 Constructor.
 IlvClosedSpline (IlvDisplay *display, IlUInt count, IlvPoint *points, IlvPalette *palette=0)
 Constructor.
const char * className () const
 Returns the class name of an object.
virtual void computeBBox (IlvRect &bbox)
 Compute the bounding box cache.
virtual IlBoolean contains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
 Checks whether a point is in the 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.
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.

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 IlvClosedSpline object appears as a closed Bézier spline.

clspline.gif


- IlvClosedSpline -


Constructor & Destructor Documentation

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

Constructor.

Creates a closed spline 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.
IlvClosedSpline::IlvClosedSpline ( IlvDisplay display,
const IlvRect ellipse,
IlvPalette palette = 0 
)

Constructor.

Creates a closed spline with the same aspect as an ellipse. Such a graphic object can perform complex geometric transformations (e.g., rotation) that the IlvEllipse class does not support.

Parameters:
display The display instance.
ellipseRect The bounding box of the ellipse.
palette The palette used to draw the graphic object.

Member Function Documentation

static void IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

const char* IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

virtual void IlvClosedSpline::computeBBox ( IlvRect bbox  )  [virtual]

Compute the bounding box cache.

Computes the actual bounding box of the object and stores it in that parameter. Is internally called to store the bounding box in a cache memory.

Parameters:
bbox Is set to the computed bounding box.

Reimplemented from IlvSpline.

virtual IlBoolean IlvClosedSpline::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:
p The point to be tested.
tp The transformed point obtained by applying the transformer t to the point p.
t A transformer value, or 0 if there is no transformation.
Returns:
IlTrue when the point p lies inside the outline of the object.

Reimplemented from IlvSpline.

Reimplemented in IlvFilledSpline.

virtual IlvGraphic* IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

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

Reimplemented in IlvFilledSpline.

virtual IlvClassInfo* IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

static IlAny IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

static const IlvClassInfo* IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

IlBoolean IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

IlBoolean IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

static IlvGraphic* IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

static IlBoolean IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

static IlBoolean IlvClosedSpline::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 IlvSpline.

Reimplemented in IlvFilledSpline.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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