IlvGraphicInstance Class Reference

Graphic handle class. More...

#include <ilviews/graphics/handle.h>

Inheritance diagram for IlvGraphicInstance:

List of all members.

Public Member Functions
	IlvGraphicInstance (IlvGraphic *obj, const IlvTransformer &t, IlvPalette *palette, IlBoolean owner=((IlBoolean) 0))
	Constructor.
	IlvGraphicInstance (IlvGraphic *obj, IlvPalette *palette, IlBoolean owner=((IlBoolean) 0))
	Constructor.
virtual IlBoolean	applyValue (const IlvValue &)
	Apply an accessor.
const char *	className () const
	Returns the class name of an object.
virtual IlvGraphic *	copy () const
	Copies this object.
virtual void	draw (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const
	Draws the graphic object.
IlvAntialiasingMode	getAntialiasingMode () const
	Retrieves the anti-aliasing mode.
IlvArcMode	getArcMode () const
	Retrieves the arc mode.
IlvColor *	getBackground () const
	Retrieves the background color.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlvColorPattern *	getColorPattern () const
	Retrieves the color pattern.
IlvFillRule	getFillRule () const
	Retrieves the fill rule.
IlvFillStyle	getFillStyle () const
	Retrieves the fill style.
IlvFont *	getFont () const
	Retrieves the font.
IlvColor *	getForeground () const
	Retrieves the foreground color.
IlvGradientPattern *	getGradientPattern () const
	Retrieves the gradient pattern.
IlvLineStyle *	getLineStyle () const
	Retrieves the line style.
IlUShort	getLineWidth () const
	Retrieves the line width.
IlvDrawMode	getMode () const
	Retrieves the draw mode.
IlBoolean	getOverwrite () const
	Retrieves the overwrite mode.
IlvPalette *	getPalette () const
	Retrieves the internal palette value.
IlvPattern *	getPattern () const
	Retrieves the pattern.
virtual void	invert (IlBoolean temp=((IlBoolean) 0))
	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 IlvValue &	queryValue (IlvValue &) const
	Retrieves the value of an accessor.
virtual void	setAntialiasingMode (IlvAntialiasingMode mode)
	Sets the anti-aliasing mode of the object.
virtual void	setArcMode (IlvArcMode m)
	Sets the arc mode of the object.
virtual void	setBackground (IlvColor *c)
	Sets the background color of the object.
virtual void	setColorPattern (IlvColorPattern *b)
	Sets the color pattern of the object.
virtual void	setFillRule (IlvFillRule m)
	Sets the fill rule of the object.
virtual void	setFillStyle (IlvFillStyle f)
	Sets the fill style of the object.
virtual void	setFont (IlvFont *f)
	Sets the font of the object.
virtual void	setForeground (IlvColor *c)
	Sets the foreground color of the object.
virtual void	setGradientPattern (IlvGradientPattern *g)
	Sets the gradient pattern of the object.
virtual void	setLineStyle (IlvLineStyle *style)
	Sets the line style of the object.
virtual void	setLineWidth (IlUShort width)
	Sets the line width of the object.
virtual void	setMode (IlvDrawMode m)
	Sets the drawing mode of the object temporarily.
virtual void	setOverwrite (IlBoolean value)
	Sets an overwrite mode that modifies how the drawing member functions operate.
void	setPalette (IlvPalette *palette)
	Sets the palette of the object.
virtual void	setPattern (IlvPattern *p)
	Sets the pattern of the object.
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file.
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 IlvClassInfo *	HasProperty (const IlSymbol *key, IlBoolean p=((IlBoolean) 0))
	Checks for the existence of a property for this object's class hierarchy.
static IlvGraphic *	read (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 handle class.

Library: views

The IlvGraphicInstance references another graphic object so that it can be drawn with another palette's attributes or transformation.

---

Constructor & Destructor Documentation

IlvGraphicInstance::IlvGraphicInstance	(	IlvGraphic *	obj,
		IlvPalette *	palette,
		IlBoolean	owner = ((IlBoolean)0)
	)

Constructor.

Parameters:

	object	The object to be referenced.
	palette	The palette that is used to display the object. This palette is locked in this constructor.
	owner	The ownership of this handle on the referenced object.

IlvGraphicInstance::IlvGraphicInstance	(	IlvGraphic *	obj,
		const IlvTransformer &	t,
		IlvPalette *	palette,
		IlBoolean	owner = ((IlBoolean)0)
	)

Constructor.

Parameters:

	obj	The object to be referenced.
	t	The initial transformation that encapsulates obj.
	palette	The palette that is used to display the object. This palette is locked in this constructor.
	owner	The ownership of this handle on the referenced object.

---

Member Function Documentation

static void IlvGraphicInstance::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 IlvTransformedGraphic.

virtual IlBoolean IlvGraphicInstance::applyValue

(

const IlvValue &

val

)

[virtual]

Apply an accessor.

This member function is called by changeValue(s) functions and must not be called directly.
Moreover, no drawing operations are carried out here (and should not be). The drawing operations are called by the changeValue(s) member functions, after having processed the call to applyValue. If you add your own new IlvValue, do not forget to override applyValue as well as changeValue and queryValue, since applyValue is called by changeValue.

Parameters:

val

The new value of the accessor.

Reimplemented from IlvGraphicHandle.

const char* IlvGraphicInstance::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 IlvTransformedGraphic.

virtual IlvGraphic* IlvGraphicInstance::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 IlvTransformedGraphic.

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

IlvAntialiasingMode IlvGraphicInstance::getAntialiasingMode

(

)

const [virtual]

Retrieves the anti-aliasing mode.

Returns:

The IlvPalette::getAntialiasingMode value of the palette.

Reimplemented from IlvGraphicHandle.

IlvArcMode IlvGraphicInstance::getArcMode

(

)

const

Retrieves the arc mode.

Returns:

The IlvPalette::getArcMode value of the palette.

IlvColor* IlvGraphicInstance::getBackground

(

)

const

Retrieves the background color.

Returns:

The IlvPalette::getBackground value of the palette.

virtual IlvClassInfo* IlvGraphicInstance::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 IlvTransformedGraphic.

IlvColorPattern* IlvGraphicInstance::getColorPattern

(

)

const

Retrieves the color pattern.

Returns:

The IlvPalette::getColorPattern value of the palette.

IlvFillRule IlvGraphicInstance::getFillRule

(

)

const

Retrieves the fill rule.

Returns:

The IlvPalette::getFillRule value of the palette.

IlvFillStyle IlvGraphicInstance::getFillStyle

(

)

const

Retrieves the fill style.

Returns:

The IlvPalette::getFillStyle value of the palette.

IlvFont* IlvGraphicInstance::getFont

(

)

const

Retrieves the font.

Returns:

The IlvPalette::getFont value of the palette.

IlvColor* IlvGraphicInstance::getForeground

(

)

const

Retrieves the foreground color.

Returns:

The IlvPalette::getForeground value of the palette.

IlvGradientPattern* IlvGraphicInstance::getGradientPattern

(

)

const

Retrieves the gradient pattern.

Returns:

The IlvPalette::getGradientPattern value of the palette.

IlvLineStyle* IlvGraphicInstance::getLineStyle

(

)

const

Retrieves the line style.

Returns:

The IlvPalette::getLineStyle value of the palette.

IlUShort IlvGraphicInstance::getLineWidth

(

)

const [virtual]

Retrieves the line width.

Returns:

The line width of the object.

Reimplemented from IlvGraphicHandle.

IlvDrawMode IlvGraphicInstance::getMode

(

)

const

Retrieves the draw mode.

Returns:

The IlvPalette::getMode value of the palette.

IlBoolean IlvGraphicInstance::getOverwrite

(

)

const

Retrieves the overwrite mode.

Returns:

The IlvPalette::getOverwrite value of the palette.

IlvPalette* IlvGraphicInstance::getPalette

(

)

const

Retrieves the internal palette value.

Returns:

A pointer to the internal palette value.

IlvPattern* IlvGraphicInstance::getPattern

(

)

const

Retrieves the pattern.

Returns:

The IlvPalette::getPattern value of the palette.

static IlAny IlvGraphicInstance::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 IlvTransformedGraphic.

static const IlvClassInfo* IlvGraphicInstance::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 IlvTransformedGraphic.

virtual void IlvGraphicInstance::invert

(

IlBoolean

temp = ((IlBoolean) 0)

)

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

IlBoolean IlvGraphicInstance::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 IlvTransformedGraphic.

IlBoolean IlvGraphicInstance::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 IlvTransformedGraphic.

virtual IlvValue& IlvGraphicInstance::queryValue

(

IlvValue &

val

)

const [virtual]

Retrieves the value of an accessor.

Retrieves the value of the accessor val. The queryValue method can be used in the following way:

 IlvValue arg("label");
 char* label = (char*)labelObject->queryValue(arg);

See IlvValue for more information.

Returns:

The value of the accessor in val.

Reimplemented from IlvGraphicHandle.

static IlvGraphic* IlvGraphicInstance::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 IlvTransformedGraphic.

static IlBoolean IlvGraphicInstance::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 IlvTransformedGraphic.

static IlBoolean IlvGraphicInstance::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 IlvTransformedGraphic.

virtual void IlvGraphicInstance::setAntialiasingMode

(

IlvAntialiasingMode

mode

)

[virtual]

Sets the anti-aliasing mode of the object.

Parameters:

mode

The new anti-aliasing mode.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setArcMode

(

IlvArcMode

mode

)

[virtual]

Sets the arc mode of the object.

Parameters:

mode

The new arc mode.

Reimplemented from IlvGraphicHandle.

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

virtual void IlvGraphicInstance::setColorPattern

(

IlvColorPattern *

pattern

)

[virtual]

Sets the color pattern of the object.

Sets the color pattern of the object.

Parameters:

pattern

The new color pattern.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setFillRule

(

IlvFillRule

rule

)

[virtual]

Sets the fill rule of the object.

Parameters:

rule

The new fill rule.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setFillStyle

(

IlvFillStyle

style

)

[virtual]

Sets the fill style of the object.

Parameters:

style

The new fill style.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setFont

(

IlvFont *

font

)

[virtual]

Sets the font of the object.

Parameters:

font

The new font.

Reimplemented from IlvGraphicHandle.

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

virtual void IlvGraphicInstance::setGradientPattern

(

IlvGradientPattern *

pattern

)

[virtual]

Sets the gradient pattern of the object.

Sets the gradient pattern of the object.

Parameters:

pattern

The new gradient pattern.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setLineStyle

(

IlvLineStyle *

style

)

[virtual]

Sets the line style of the object.

Parameters:

style

The new line style.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setLineWidth

(

IlUShort

width

)

[virtual]

Sets the line width of the object.

Parameters:

width

The new line width.

Reimplemented from IlvGraphicHandle.

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

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

void IlvGraphicInstance::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:

palette

The palette to be set.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::setPattern

(

IlvPattern *

pattern

)

[virtual]

Sets the pattern of the object.

Sets the pattern of the object.

Parameters:

pattern

The new pattern.

Reimplemented from IlvGraphicHandle.

virtual void IlvGraphicInstance::write

(

IlvOutputFile &

output

)

const [virtual]

Writes an object description to a file.

Writes out, in a file, the object description. This description contains all the information necessary to create an exact copy of this object by means of the member function read. Information concerning any IlvPalette object attached to this object is written out by the object containers. All other information, such as the position and size of the object, is written out by this virtual member function.
For example, suppose we have an IlvLabel class that implements a graphic object drawn as a text string at a given position. It maintains its position in an internal IlvPoint field called _position and its textual content in an internal character array field called _text. The only information we need to save is the contents of those fields. So, the member function write of such an object should have the following form:

 void
 IlvLabel::write(IlvOutputFile& file) const
 {
     // Save the position field
     file.getStream() << IlvSpc() << _position;
     // Save the text field
     IlvWriteString(file.getStream(), _text);
 }

Parameters:

output

The the output file to be written to.

See also:

DeclareTypeInfo.

Reimplemented from IlvTransformedGraphic.