Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
Graphic3d_PresentationAttributes Class Reference

Class defines presentation properties. More...

#include <Graphic3d_PresentationAttributes.hxx>

Inheritance diagram for Graphic3d_PresentationAttributes:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_PresentationAttributes ()
 Empty constructor.
 
 ~Graphic3d_PresentationAttributes () override=default
 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).
 
float Transparency () const
 Returns basic presentation transparency (0 - opaque, 1 - fully transparent), 0 by default (opaque).
 
virtual void SetTransparency (const float 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.
 
int DisplayMode () const
 Returns display mode, 0 by default. -1 means undefined (main display mode of presentation to be used).
 
virtual void SetDisplayMode (const int theMode)
 Sets display mode.
 
const occ::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 occ::handle< Graphic3d_AspectFillArea3d > &theAspect)
 Sets basic presentation fill area aspect.
 
virtual void DumpJson (Standard_OStream &theOStream, int 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 ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Protected Attributes

occ::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.
 
int 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()

Graphic3d_PresentationAttributes::~Graphic3d_PresentationAttributes ( )
overridedefault

Destructor.

Member Function Documentation

◆ BasicFillAreaAspect()

const occ::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()

int 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,
int 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 occ::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 int 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 float 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()

float 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

occ::handle<Graphic3d_AspectFillArea3d> Graphic3d_PresentationAttributes::myBasicFillAreaAspect
protected

presentation fill area aspect

◆ myDispMode

int 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:
Generated by doxygen 1.10.0