OdGiVisualStyleDataContainer Class Reference

#include <GiVisualStyleData.h>

Inheritance diagram for OdGiVisualStyleDataContainer:

Classes
struct	OdCmColorBaseAdapt
class	OdGiDisplayStyleDataContainer
class	OdGiEdgeStyleDataContainer
class	OdGiFaceStyleDataContainer

Public Member Functions
	OdGiVisualStyleDataContainer ()
	~OdGiVisualStyleDataContainer ()
virtual OdGiFaceStyle &	faceStyle ()
virtual OdGiEdgeStyle &	edgeStyle ()
virtual OdGiDisplayStyle &	displayStyle ()
virtual const OdGiFaceStyle &	faceStyle () const
virtual const OdGiEdgeStyle &	edgeStyle () const
virtual const OdGiDisplayStyle &	displayStyle () const
virtual void	setFaceStyle (const OdGiFaceStyle &style)
virtual void	setEdgeStyle (const OdGiEdgeStyle &style)
virtual void	setDisplayStyle (const OdGiDisplayStyle &style)
virtual bool	setType (Type type)
virtual Type	type () const
virtual bool	setTrait (Property prop, Operation op)
virtual bool	setTrait (Property prop, const OdGiVariant *pVal, Operation op=OdGiVisualStyleOperations::kSet)
virtual OdGiVariantPtr	trait (Property prop, Operation *pOp=NULL) const
virtual Operation	operation (Property prop) const
Public Member Functions inherited from OdStaticRxObject< OdGiVisualStyle >
void	addRef ()
void	release ()
Public Member Functions inherited from OdGiVisualStyle
	ODRX_DECLARE_MEMBERS (OdGiVisualStyle)
OdGiVisualStyle &	operator= (const OdGiVisualStyle &visualStyle)
bool	operator== (const OdGiVisualStyle &visualStyle) const
virtual OdGiFaceStyle &	faceStyle (void)=0
virtual OdGiEdgeStyle &	edgeStyle (void)=0
virtual OdGiDisplayStyle &	displayStyle (void)=0
virtual const OdGiFaceStyle &	faceStyle (void) const =0
virtual const OdGiEdgeStyle &	edgeStyle (void) const =0
virtual const OdGiDisplayStyle &	displayStyle (void) const =0
virtual void	setFaceStyle (const OdGiFaceStyle &style)=0
virtual void	setEdgeStyle (const OdGiEdgeStyle &style)=0
virtual void	setDisplayStyle (const OdGiDisplayStyle &style)=0
void	configureForType (Type type)
virtual bool	setType (Type type)=0
virtual Type	type () const =0
virtual bool	setTrait (Property prop, Operation op)=0
virtual bool	setTrait (Property prop, const OdGiVariant *pVal, Operation op=OdGiVisualStyleOperations::kSet)=0
virtual bool	setTrait (Property prop, OdInt32 nVal, Operation op=OdGiVisualStyleOperations::kSet)
virtual bool	setTrait (Property prop, bool bVal, Operation op=OdGiVisualStyleOperations::kSet)
virtual bool	setTrait (Property prop, double dVal, Operation op=OdGiVisualStyleOperations::kSet)
virtual bool	setTrait (Property prop, double red, double green, double blue, Operation op=OdGiVisualStyleOperations::kSet)
virtual bool	setTrait (Property prop, const OdCmColorBase &pColor, Operation op=OdGiVisualStyleOperations::kSet)
virtual bool	setTrait (Property prop, const OdCmEntityColor &pColor, Operation op=OdGiVisualStyleOperations::kSet)
virtual bool	setTrait (Property prop, const OdString &pStr, Operation op=OdGiVisualStyleOperations::kSet)
virtual OdGiVariantPtr	trait (Property prop, Operation *pOp=NULL) const =0
virtual Operation	operation (Property prop) const =0
virtual bool	setTraitFlag (Property flagProp, OdUInt32 flagVal, bool bEnable=true)
virtual bool	traitFlag (Property flagProp, OdUInt32 flagVal) const
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

Protected Attributes
OdGiFaceStyleDataContainer	m_faceStyle
OdGiEdgeStyleDataContainer	m_edgeStyle
OdGiDisplayStyleDataContainer	m_displayStyle
Type	m_type
OdStaticRxObject< OdGiVariant >	m_props [OdGiVisualStyleProperties::kPropertyCount]
Operation	m_ops [OdGiVisualStyleProperties::kPropertyCount]

Additional Inherited Members
Public Types inherited from OdGiVisualStyle
enum	Type {   kFlat , kFlatWithEdges , kGouraud , kGouraudWithEdges ,   k2DWireframe , k3DWireframe , kHidden , kBasic ,   kRealistic , kConceptual , kCustom , kDim ,   kBrighten , kThicken , kLinePattern , kFacePattern ,   kColorChange , kFaceOnly , kEdgeOnly , kDisplayOnly ,   kJitterOff , kOverhangOff , kEdgeColorOff , kShadesOfGray ,   kSketchy , kXRay , kShadedWithEdges , kShaded ,   kByViewport , kByLayer , kByBlock , kEmptyStyle }
typedef OdGiVisualStyleProperties::Property	Property
typedef OdGiVisualStyleOperations::Operation	Operation
Static Public Member Functions inherited from OdGiVisualStyle
static OdGiVariant::VariantType	propertyType (Property prop)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

<group OdGi_Classes>

This class defines the container for visual style data.

Corresponding C++ library: TD_Gi

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 43 of file GiVisualStyleData.h.

Constructor & Destructor Documentation

OdGiVisualStyleDataContainer()

OdGiVisualStyleDataContainer::OdGiVisualStyleDataContainer ( )

inline

Default constructor for the OdGiVisualStyleDataContainer class. Sets face, edge and display styles and also sets values for face, edge and display properties.

Definition at line 1349 of file GiVisualStyleData.h.

~OdGiVisualStyleDataContainer()

OdGiVisualStyleDataContainer::~OdGiVisualStyleDataContainer ( )

inline

Destructor for the OdGiVisualStyleDataContainer class.

Definition at line 1433 of file GiVisualStyleData.h.

Member Function Documentation

displayStyle() [1/2]

virtual OdGiDisplayStyle & OdGiVisualStyleDataContainer::displayStyle ( void  )

inlinevirtual

Returns a reference to OdGiDisplayStyle of this visual style.

Implements OdGiVisualStyle.

Definition at line 1456 of file GiVisualStyleData.h.

displayStyle() [2/2]

virtual const OdGiDisplayStyle & OdGiVisualStyleDataContainer::displayStyle ( void  ) const

inlinevirtual

Returns a reference to OdGiDisplayStyle of this visual style.

Implements OdGiVisualStyle.

Definition at line 1480 of file GiVisualStyleData.h.

edgeStyle() [1/2]

virtual OdGiEdgeStyle & OdGiVisualStyleDataContainer::edgeStyle ( void  )

inlinevirtual

Returns a reference to OdGiEdgeStyle of this visual style.

Implements OdGiVisualStyle.

Definition at line 1448 of file GiVisualStyleData.h.

edgeStyle() [2/2]

virtual const OdGiEdgeStyle & OdGiVisualStyleDataContainer::edgeStyle ( void  ) const

inlinevirtual

Returns a reference to OdGiEdgeStyle of this visual style.

Implements OdGiVisualStyle.

Definition at line 1472 of file GiVisualStyleData.h.

faceStyle() [1/2]

virtual OdGiFaceStyle & OdGiVisualStyleDataContainer::faceStyle ( void  )

inlinevirtual

Returns a reference to OdGiFaceStyle of this visual style.

Implements OdGiVisualStyle.

Definition at line 1440 of file GiVisualStyleData.h.

faceStyle() [2/2]

virtual const OdGiFaceStyle & OdGiVisualStyleDataContainer::faceStyle ( void  ) const

inlinevirtual

Returns a reference to OdGiFaceStyle of this visual style.

Implements OdGiVisualStyle.

Definition at line 1464 of file GiVisualStyleData.h.

operation()

virtual Operation OdGiVisualStyleDataContainer::operation ( Property  prop ) const

inlinevirtual

Gets the operation associated with the given property of the visual style.

Parameters

prop	[in] Property to get.

Returns

Returns the operation associated with the specified property if successful, otherwise the kInvalidOperation value.

Implements OdGiVisualStyle.

Definition at line 1617 of file GiVisualStyleData.h.

setDisplayStyle()

virtual void OdGiVisualStyleDataContainer::setDisplayStyle ( const OdGiDisplayStyle &  style )

inlinevirtual

Copies all properties of OdGiDisplayStyle into this visual style.

Parameters

style

[in] Collection of display properties.

Implements OdGiVisualStyle.

Definition at line 1510 of file GiVisualStyleData.h.

setEdgeStyle()

virtual void OdGiVisualStyleDataContainer::setEdgeStyle ( const OdGiEdgeStyle &  style )

inlinevirtual

Copies all properties of OdGiEdgeStyle into this visual style.

Parameters

style

[in] Collection of edge properties.

Implements OdGiVisualStyle.

Definition at line 1500 of file GiVisualStyleData.h.

setFaceStyle()

virtual void OdGiVisualStyleDataContainer::setFaceStyle ( const OdGiFaceStyle &  style )

inlinevirtual

Copies all properties of OdGiFaceStyle into this visual style.

Parameters

style

[in] Collection of face properties.

Implements OdGiVisualStyle.

Definition at line 1490 of file GiVisualStyleData.h.

setTrait() [1/2]

virtual bool OdGiVisualStyleDataContainer::setTrait ( Property  prop, const OdGiVariant *  pVal, Operation  op = OdGiVisualStyleOperations::kSet  )

inlinevirtual

Sets a property of the visual style.

Parameters

prop	[in] Property to set.
pVal	[in] Pointer to the OdGiVariant property value to set.
op	[in] Operation to use for setting the property.

Returns

Returns true if successful, otherwise false.

Implements OdGiVisualStyle.

Definition at line 1576 of file GiVisualStyleData.h.

setTrait() [2/2]

virtual bool OdGiVisualStyleDataContainer::setTrait ( Property  prop, Operation  op  )

inlinevirtual

Sets the operation associated with the given property.

Parameters

prop	[in] Property for which the operation is to be set.
op	[in] Operation to use for setting the property.

Returns

Returns true if successful, otherwise false.

Implements OdGiVisualStyle.

Definition at line 1556 of file GiVisualStyleData.h.

setType()

virtual bool OdGiVisualStyleDataContainer::setType ( Type  type )

inlinevirtual

Sets the given visual style type. Multiple properties are modified to change the visual style into the specified type.

Parameters

type	[in] Type of visual style to set. All available types are defined in the Type enumeration.

Returns

Returns true if successful, otherwise false.

Implements OdGiVisualStyle.

Definition at line 1525 of file GiVisualStyleData.h.

trait()

virtual OdGiVariantPtr OdGiVisualStyleDataContainer::trait ( Property  prop, Operation *  pOp = NULL  ) const

inlinevirtual

Gets a property of the visual style.

Parameters

prop	[in] Property to get.
pOp	[in] Pointer to the operation used for the property. If NULL, nothing is returned.

Returns

Returns an OdGiVariantPtr for the property value if successful, otherwise an empty OdGiVariantPtr object.

Implements OdGiVisualStyle.

Definition at line 1598 of file GiVisualStyleData.h.

type()

virtual Type OdGiVisualStyleDataContainer::type ( ) const

inlinevirtual

Returns the current visual style type.

Implements OdGiVisualStyle.

Definition at line 1542 of file GiVisualStyleData.h.

Member Data Documentation

m_displayStyle

OdGiDisplayStyleDataContainer OdGiVisualStyleDataContainer::m_displayStyle

protected

Definition at line 1340 of file GiVisualStyleData.h.

m_edgeStyle

OdGiEdgeStyleDataContainer OdGiVisualStyleDataContainer::m_edgeStyle

protected

Definition at line 1339 of file GiVisualStyleData.h.

m_faceStyle

OdGiFaceStyleDataContainer OdGiVisualStyleDataContainer::m_faceStyle

protected

Definition at line 1338 of file GiVisualStyleData.h.

m_ops

Operation OdGiVisualStyleDataContainer::m_ops[OdGiVisualStyleProperties::kPropertyCount]

protected

Definition at line 1343 of file GiVisualStyleData.h.

m_props

OdStaticRxObject<OdGiVariant> OdGiVisualStyleDataContainer::m_props[OdGiVisualStyleProperties::kPropertyCount]

protected

Definition at line 1342 of file GiVisualStyleData.h.

m_type

Type OdGiVisualStyleDataContainer::m_type

protected

Definition at line 1341 of file GiVisualStyleData.h.

---

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

• GiVisualStyleData.h