IlvReliefLine Class Reference

Graphic class. More...

#include <ilviews/graphics/relfline.h>

Inheritance diagram for IlvReliefLine:

List of all members.

Public Member Functions
	IlvReliefLine (IlvDisplay *display, const IlvPoint &from, const IlvPoint &to, IlUShort thickness=1, IlvPalette *palette=0)
	Constructor.
virtual void	boundingBox (IlvRect &, const IlvTransformer *t=0) const
	Retrieves the bounding box of the graphic object.
const char *	className () const
	Returns the class name of an object.
virtual IlBoolean	contains (const IlvPoint &, const IlvPoint &, const IlvTransformer *t=0) const
	Checks whether a point is in the 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.
virtual IlvClassInfo *	getClassInfo () const
	Gets class information.
IlUShort	getThickness () const
	Returns the thickness of the line.
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 *c)
	Sets the background color of the object.
virtual void	setForeground (IlvColor *c)
	Sets the foreground color 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.
virtual void	setPalette (IlvPalette *)
	Sets the internal palette to the given palette value.
void	setThickness (IlUShort value)
	Sets the thickness of the line.
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 class.

Library: views

An IlvReliefLine object appears as a line with a three-dimensional look.

- IlvReliefLine -

---

Constructor & Destructor Documentation

IlvReliefLine::IlvReliefLine	(	IlvDisplay *	display,
		const IlvPoint &	from,
		const IlvPoint &	to,
		IlUShort	thickness = 1,
		IlvPalette *	palette = 0
	)

Constructor.

Parameters:

	display	The display instance.
	from	The first extremity of the line.
	to	The second extremity of the line.
	thickness	Specifies the thickness of the relief line.
	palette	The palette used to draw the graphic object.

---

Member Function Documentation

static void IlvReliefLine::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 IlvLine.

virtual void IlvReliefLine::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:

	bbox	The bounding box to be set.
	t	A transformer value or 0 if there is no transformation.

Reimplemented from IlvLine.

const char* IlvReliefLine::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 IlvLine.

virtual IlBoolean IlvReliefLine::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 IlvLine.

virtual IlvGraphic* IlvReliefLine::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 IlvLine.

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

virtual IlvClassInfo* IlvReliefLine::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 IlvLine.

static IlAny IlvReliefLine::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 IlvLine.

IlUShort IlvReliefLine::getThickness

(

)

const

Returns the thickness of the line.

Returns:

The thickness of the line.

static const IlvClassInfo* IlvReliefLine::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 IlvLine.

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

IlBoolean IlvReliefLine::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 IlvLine.

static IlvGraphic* IlvReliefLine::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 IlvLine.

static IlBoolean IlvReliefLine::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 IlvLine.

static IlBoolean IlvReliefLine::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 IlvLine.

virtual void IlvReliefLine::setAlpha

(

IlvIntensity

alpha

)

[virtual]

Sets the alpha value of the object.

Parameters:

alpha

The new alpha value.

Reimplemented from IlvSimpleGraphic.

virtual void IlvReliefLine::setAntialiasingMode

(

IlvAntialiasingMode

mode

)

[virtual]

Sets the anti-aliasing mode of the object.

Parameters:

mode

The new anti-aliasing mode.

Reimplemented from IlvSimpleGraphic.

virtual void IlvReliefLine::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 IlvReliefLine::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 IlvReliefLine::setLineStyle

(

IlvLineStyle *

style

)

[virtual]

Sets the line style of the object.

Parameters:

style

The new line style.

Reimplemented from IlvSimpleGraphic.

virtual void IlvReliefLine::setLineWidth

(

IlUShort

width

)

[virtual]

Sets the line width of the object.

Parameters:

width

The new line width.

Reimplemented from IlvSimpleGraphic.

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

void IlvReliefLine::setThickness

(

IlUShort

value

)

Sets the thickness of the line.

Parameters:

thickness

The new value for the line thickness.

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