OdGiDisplayStyle Class Reference

#include <GiVisualStyle.h>

Inheritance diagram for OdGiDisplayStyle:

Public Types
enum	DisplaySettings {   kNone = 0x00 , kBackgrounds = 0x01 , kLights = 0x02 , kMaterials = 0x04 ,   kTextures = 0x08 }
enum	ShadowType { kShadowsNone = 0 , kShadowsGroundPlane = 1 , kShadowsFull = 2 , kShadowsFullAndGround = 3 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiDisplayStyle)
void	set (const OdGiDisplayStyle &style)
OdGiDisplayStyle &	operator= (const OdGiDisplayStyle &style)
bool	operator== (const OdGiDisplayStyle &style) const
virtual void	setDisplaySettings (unsigned long nSettings)=0
virtual void	setDisplaySettingsFlag (DisplaySettings flag, bool bEnable)=0
virtual unsigned long	displaySettings () const =0
virtual bool	isDisplaySettingsFlagSet (DisplaySettings flag) const =0
virtual void	setBrightness (double value)=0
virtual double	brightness () const =0
virtual void	setShadowType (ShadowType type)=0
virtual ShadowType	shadowType () const =0
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 defines a set of display properties that can be applied to graphical entities.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 699 of file GiVisualStyle.h.

Member Enumeration Documentation

DisplaySettings

enum OdGiDisplayStyle::DisplaySettings

Defines a combination of display settings that can be enabled.

Enumerator
kNone
kBackgrounds
kLights
kMaterials
kTextures

Definition at line 707 of file GiVisualStyle.h.

ShadowType

enum OdGiDisplayStyle::ShadowType

Defines shadows types that can be displayed.

Enumerator
kShadowsNone
kShadowsGroundPlane
kShadowsFull
kShadowsFullAndGround

Definition at line 719 of file GiVisualStyle.h.

Member Function Documentation

brightness()

virtual double OdGiDisplayStyle::brightness ( ) const

pure virtual

Returns the brightness level.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

displaySettings()

virtual unsigned long OdGiDisplayStyle::displaySettings ( ) const

pure virtual

Returns the collection of currently used display settings flags.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

isDisplaySettingsFlagSet()

virtual bool OdGiDisplayStyle::isDisplaySettingsFlagSet ( DisplaySettings  flag ) const

pure virtual

Returns whether the specified display settings flag is enabled.

Parameters

flag	[in] Flag to be checked whether it's enabled or disabled.

Returns

true if the passed display setting flag is set, false otherwise.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

ODRX_DECLARE_MEMBERS()

OdGiDisplayStyle::ODRX_DECLARE_MEMBERS

(

OdGiDisplayStyle

)

operator=()

OdGiDisplayStyle & OdGiDisplayStyle::operator=

(

const OdGiDisplayStyle &

style

)

Assignment operator for the OdGiDisplayStyle class. Returns reference to OdGiDisplayStyle with new assigned style properties.

Parameters

style

[in] Display style properties to assign.

operator==()

bool OdGiDisplayStyle::operator==

(

const OdGiDisplayStyle &

style

)

const

Equality operator for the OdGiDisplayStyle class. Style properties are considered equal if: Display settings are equal; Brightness values are equal; Shadow types are equal;

Parameters

style

[in] Display style to compare.

Returns

true if display styles are equal, false otherwise.

set()

void OdGiDisplayStyle::set

(

const OdGiDisplayStyle &

style

)

Sets values of the given display style to this display style.

Parameters

style

[in] Reference to the OdGiDisplayStyle to copy into this display style.

setBrightness()

virtual void OdGiDisplayStyle::setBrightness ( double  value )

pure virtual

Sets the brightness value.

Parameters

value

[in] Brightness level to set.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

setDisplaySettings()

virtual void OdGiDisplayStyle::setDisplaySettings ( unsigned long  nSettings )

pure virtual

Sets a collection of bitflags representing the display settings.

Parameters

nSettings

[in] Unsigned long value that represents a collection of bitwise flags defined in the DisplaySettings enumeration.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

setDisplaySettingsFlag()

virtual void OdGiDisplayStyle::setDisplaySettingsFlag ( DisplaySettings  flag, bool  bEnable  )

pure virtual

Enables or disables the specified display settings flag.

Parameters

flag	[in] Flag to enable or disable.
bEnable	[in] Value that indicates whether to enable or disable the specified flag.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

setShadowType()

virtual void OdGiDisplayStyle::setShadowType ( ShadowType  type )

pure virtual

Sets the shadow type.

Parameters

type	[in] Shadow type to set. All available types are defined in the ShadowType enumeration.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

shadowType()

virtual ShadowType OdGiDisplayStyle::shadowType ( ) const

pure virtual

Returns the currently used shadow type.

Implemented in OdGiVisualStyleDataContainer::OdGiDisplayStyleDataContainer.

---

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

• GiVisualStyle.h