RenderingObjectInstallData Class Reference

#include <IRenderingObject.h>

Public Member Functions
virtual PMReal	GetTint ()=0
virtual void	SetTint (PMReal tint)=0
virtual bool16	GradientValuesSet ()=0
virtual void	SetGradientValues (PMReal fillAngle, PMReal fillLength, PMPoint fillCenter, PMReal fillRadius, PMReal highlightAngle, PMReal highlightLength)=0
virtual PMReal	GetFillAngle ()=0
virtual PMReal	GetFillLength ()=0
virtual PMPoint	GetFillCenter ()=0
virtual PMReal	GetFillRadius ()=0
virtual PMReal	GetHighlightAngle ()=0
virtual PMReal	GetHighlighLength ()=0

Detailed Description

A helper class to facilitate installing the rendering object with specific attributes. Two types of attributes are supported, tint or gradient. They are mutually exclusive.

Member Function Documentation

virtual PMReal RenderingObjectInstallData::GetFillAngle ( )

pure virtual

Returns the gradient angle.

Returns

the gradient angle.

virtual PMPoint RenderingObjectInstallData::GetFillCenter ( )

pure virtual

Returns the gradient center or start point.

Returns

the gradient center or start point.

virtual PMReal RenderingObjectInstallData::GetFillLength ( )

pure virtual

Returns the gradient length.

Returns

the gradient length.

virtual PMReal RenderingObjectInstallData::GetFillRadius ( )

pure virtual

Returns the gradient radius.

Returns

the gradient radius.

virtual PMReal RenderingObjectInstallData::GetHighlighLength ( )

pure virtual

Returns the gradient highlight length.

Returns

the gradient highlight length.

virtual PMReal RenderingObjectInstallData::GetHighlightAngle ( )

pure virtual

Returns the gradient highlight angle.

Returns

the gradient highlight angle.

virtual PMReal RenderingObjectInstallData::GetTint ( )

pure virtual

Returns a tint value.

Returns

a tint value.

virtual bool16 RenderingObjectInstallData::GradientValuesSet ( )

pure virtual

Return kTrue if gradient attribute values are used.

Returns

kTrue if gradient attribute values are used.

virtual void RenderingObjectInstallData::SetGradientValues ( PMReal  fillAngle, PMReal  fillLength, PMPoint  fillCenter, PMReal  fillRadius, PMReal  highlightAngle, PMReal  highlightLength  )

pure virtual

Sets related gradient attributes values

Parameters

fillAngle	the gradient angle to set.
fillLength	the gradient length to set.
fillCenter	the gradient start point or center to set.
fillRadius	the radial gradient radius to set.
highlightAngle	the gradient highlight angle to set.
highlightLength	the gradient highlight length to set.

virtual void RenderingObjectInstallData::SetTint ( PMReal  tint )

pure virtual

Sets a tint value.

Parameters

tint	the tint value to set.