Graphic3d_PresentationAttributes Class Reference

Class defines presentation properties. More...

#include <Graphic3d_PresentationAttributes.hxx>

Inheritance diagram for Graphic3d_PresentationAttributes:

Public Member Functions
	Graphic3d_PresentationAttributes ()
	Empty constructor.
virtual	~Graphic3d_PresentationAttributes ()
	Destructor.
Aspect_TypeOfHighlightMethod	Method () const
	Returns highlight method, Aspect_TOHM_COLOR by default.
virtual void	SetMethod (const Aspect_TypeOfHighlightMethod theMethod)
	Changes highlight method to the given one.
const Quantity_ColorRGBA &	ColorRGBA () const
	Returns basic presentation color (including alpha channel).
const Quantity_Color &	Color () const
	Returns basic presentation color, Quantity_NOC_WHITE by default.
virtual void	SetColor (const Quantity_Color &theColor)
	Sets basic presentation color (RGB components, does not modifies transparency).
Standard_ShortReal	Transparency () const
	Returns basic presentation transparency (0 - opaque, 1 - fully transparent), 0 by default (opaque).
virtual void	SetTransparency (const Standard_ShortReal theTranspCoef)
	Sets basic presentation transparency (0 - opaque, 1 - fully transparent).
Graphic3d_ZLayerId	ZLayer () const
	Returns presentation Zlayer, Graphic3d_ZLayerId_Default by default. Graphic3d_ZLayerId_UNKNOWN means undefined (a layer of main presentation to be used).
virtual void	SetZLayer (const Graphic3d_ZLayerId theLayer)
	Sets presentation Zlayer.
Standard_Integer	DisplayMode () const
	Returns display mode, 0 by default. -1 means undefined (main display mode of presentation to be used).
virtual void	SetDisplayMode (const Standard_Integer theMode)
	Sets display mode.
const Handle< Graphic3d_AspectFillArea3d > &	BasicFillAreaAspect () const
	Return basic presentation fill area aspect, NULL by default. When set, might be used instead of Color() property.
virtual void	SetBasicFillAreaAspect (const Handle< Graphic3d_AspectFillArea3d > &theAspect)
	Sets basic presentation fill area aspect.
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
Handle< Graphic3d_AspectFillArea3d >	myBasicFillAreaAspect
	presentation fill area aspect
Quantity_ColorRGBA	myBasicColor
	presentation color
Aspect_TypeOfHighlightMethod	myHiMethod
	box or color highlighting
Graphic3d_ZLayerId	myZLayer
	Z-layer.
Standard_Integer	myDispMode
	display mode

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Class defines presentation properties.

Constructor & Destructor Documentation

Graphic3d_PresentationAttributes()

Graphic3d_PresentationAttributes::Graphic3d_PresentationAttributes ( )

inline

Empty constructor.

~Graphic3d_PresentationAttributes()

virtual Graphic3d_PresentationAttributes::~Graphic3d_PresentationAttributes ( )

inlinevirtual

Destructor.

Member Function Documentation

BasicFillAreaAspect()

const Handle< Graphic3d_AspectFillArea3d > & Graphic3d_PresentationAttributes::BasicFillAreaAspect ( ) const

inline

Return basic presentation fill area aspect, NULL by default. When set, might be used instead of Color() property.

Color()

const Quantity_Color & Graphic3d_PresentationAttributes::Color ( ) const

inline

Returns basic presentation color, Quantity_NOC_WHITE by default.

ColorRGBA()

const Quantity_ColorRGBA & Graphic3d_PresentationAttributes::ColorRGBA ( ) const

inline

Returns basic presentation color (including alpha channel).

DisplayMode()

Standard_Integer Graphic3d_PresentationAttributes::DisplayMode ( ) const

inline

Returns display mode, 0 by default. -1 means undefined (main display mode of presentation to be used).

DumpJson()

virtual void Graphic3d_PresentationAttributes::DumpJson ( Standard_OStream &  theOStream, Standard_Integer  theDepth = -1  ) const

virtual

Dumps the content of me into the stream.

Reimplemented in Prs3d_Drawer.

Method()

Aspect_TypeOfHighlightMethod Graphic3d_PresentationAttributes::Method ( ) const

inline

Returns highlight method, Aspect_TOHM_COLOR by default.

SetBasicFillAreaAspect()

virtual void Graphic3d_PresentationAttributes::SetBasicFillAreaAspect ( const Handle< Graphic3d_AspectFillArea3d > &  theAspect )

inlinevirtual

Sets basic presentation fill area aspect.

SetColor()

virtual void Graphic3d_PresentationAttributes::SetColor ( const Quantity_Color &  theColor )

inlinevirtual

Sets basic presentation color (RGB components, does not modifies transparency).

SetDisplayMode()

virtual void Graphic3d_PresentationAttributes::SetDisplayMode ( const Standard_Integer  theMode )

inlinevirtual

Sets display mode.

SetMethod()

virtual void Graphic3d_PresentationAttributes::SetMethod ( const Aspect_TypeOfHighlightMethod  theMethod )

inlinevirtual

Changes highlight method to the given one.

SetTransparency()

virtual void Graphic3d_PresentationAttributes::SetTransparency ( const Standard_ShortReal  theTranspCoef )

inlinevirtual

Sets basic presentation transparency (0 - opaque, 1 - fully transparent).

SetZLayer()

virtual void Graphic3d_PresentationAttributes::SetZLayer ( const Graphic3d_ZLayerId  theLayer )

inlinevirtual

Sets presentation Zlayer.

Transparency()

Standard_ShortReal Graphic3d_PresentationAttributes::Transparency ( ) const

inline

Returns basic presentation transparency (0 - opaque, 1 - fully transparent), 0 by default (opaque).

ZLayer()

Graphic3d_ZLayerId Graphic3d_PresentationAttributes::ZLayer ( ) const

inline

Returns presentation Zlayer, Graphic3d_ZLayerId_Default by default. Graphic3d_ZLayerId_UNKNOWN means undefined (a layer of main presentation to be used).

Field Documentation

myBasicColor

Quantity_ColorRGBA Graphic3d_PresentationAttributes::myBasicColor

protected

presentation color

myBasicFillAreaAspect

Handle< Graphic3d_AspectFillArea3d > Graphic3d_PresentationAttributes::myBasicFillAreaAspect

protected

presentation fill area aspect

myDispMode

Standard_Integer Graphic3d_PresentationAttributes::myDispMode

protected

display mode

myHiMethod

Aspect_TypeOfHighlightMethod Graphic3d_PresentationAttributes::myHiMethod

protected

box or color highlighting

myZLayer

Graphic3d_ZLayerId Graphic3d_PresentationAttributes::myZLayer

protected

Z-layer.

---

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

• Graphic3d_PresentationAttributes.hxx