OdGiGradientBackgroundTraits Class Reference

#include <GiEnvironment.h>

Inheritance diagram for OdGiGradientBackgroundTraits:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiGradientBackgroundTraits)
virtual void	setColorTop (const OdCmEntityColor &color)=0
virtual OdCmEntityColor	colorTop () const =0
virtual void	setColorMiddle (const OdCmEntityColor &color)=0
virtual OdCmEntityColor	colorMiddle () const =0
virtual void	setColorBottom (const OdCmEntityColor &color)=0
virtual OdCmEntityColor	colorBottom () const =0
virtual void	setHorizon (double horizon)=0
virtual double	horizon () const =0
virtual void	setHeight (double height)=0
virtual double	height () const =0
virtual void	setRotation (double rotation)=0
virtual double	rotation () const =0
Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class represents traits that are related to the gradient backgrounds.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1268 of file GiEnvironment.h.

Member Function Documentation

colorBottom()

virtual OdCmEntityColor OdGiGradientBackgroundTraits::colorBottom ( ) const

pure virtual

Retrieves a bottom color of this background.

Returns

bottom color as instance of the OdCmEntityColor class.

colorMiddle()

virtual OdCmEntityColor OdGiGradientBackgroundTraits::colorMiddle ( ) const

pure virtual

Retrieves a middle color of this background.

Returns

middle color as instance of the OdCmEntityColor class.

colorTop()

virtual OdCmEntityColor OdGiGradientBackgroundTraits::colorTop ( ) const

pure virtual

Retrieves a top color of this background.

Returns

top color as instance of the OdCmEntityColor class.

height()

virtual double OdGiGradientBackgroundTraits::height ( ) const

pure virtual

Receives height of the middle color.

Returns

height of a middle color.

horizon()

virtual double OdGiGradientBackgroundTraits::horizon ( ) const

pure virtual

Retrieves a position of a middle color relative to top and bottom colors.

Returns

horizon that represents position of a middle color relative to top and bottom colors.

ODRX_DECLARE_MEMBERS()

OdGiGradientBackgroundTraits::ODRX_DECLARE_MEMBERS

(

OdGiGradientBackgroundTraits

)

rotation()

virtual double OdGiGradientBackgroundTraits::rotation ( ) const

pure virtual

Receives rotation of the gradient.

Returns

degrees of counter clock-wise gradient rotation.

setColorBottom()

virtual void OdGiGradientBackgroundTraits::setColorBottom ( const OdCmEntityColor &  color )

pure virtual

Specifies a bottom color for this background.

Parameters

color

[in] Bottom color.

setColorMiddle()

virtual void OdGiGradientBackgroundTraits::setColorMiddle ( const OdCmEntityColor &  color )

pure virtual

Specifies a middle color for this background.

Parameters

color

[in] Middle color.

setColorTop()

virtual void OdGiGradientBackgroundTraits::setColorTop ( const OdCmEntityColor &  color )

pure virtual

Specifies a top color for this background.

Parameters

color

[in] Top color.

setHeight()

virtual void OdGiGradientBackgroundTraits::setHeight ( double  height )

pure virtual

Specifies height of the middle color.

Parameters

height

[in] Height of the middle color.

Remarks

For example, if you call the setHorizon() method and pass 0.5 and then call this method with 0.33 value then all 3 gradient colors are equally distributed inside scene window (if no rotation applied).

setHorizon()

virtual void OdGiGradientBackgroundTraits::setHorizon ( double  horizon )

pure virtual

Specifies a position of a middle color relative to top and bottom colors.

Parameters

horizon

[in] Position of a middle color in range where 0 is the beginning of device coordinate system and 1 is end of of device coordinate system.

Remarks

For example, if you call this method and pass 0.5, a middle color will reside in the middle of a window (if no rotation applied). The passed value may lie out of [0..1] range, which means that position for middle color is set off-screen.

setRotation()

virtual void OdGiGradientBackgroundTraits::setRotation ( double  rotation )

pure virtual

Specifies rotation of the gradient.

Parameters

rotation

[in] Rotation in degrees.

Remarks

Rotation is performed the counter clock-wise direction, relative to window coordinates. For example, if you call this method with the 45.0 value the gradient background is so the beginning of gradient is in lower-left corner of a window and the end is in the upper-right corner.

---

The documentation for this class was generated from the following file:

• GiEnvironment.h