Open CASCADE Technology  7.1.0.beta
Public Member Functions
Graphic3d_HighlightStyle Class Reference

A class for setting up highlight properties, such as: More...

#include <Graphic3d_HighlightStyle.hxx>

Inheritance diagram for Graphic3d_HighlightStyle:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_HighlightStyle (const Aspect_TypeOfHighlightMethod theMethod=Aspect_TOHM_COLOR, const Quantity_Color &theColor=Quantity_NOC_WHITE, const Standard_ShortReal theTransparency=0.f)
 Creates the style. Default parameters are: More...
 
 Graphic3d_HighlightStyle (const Handle< Graphic3d_HighlightStyle > &theOther)
 Creates a copy of the given style. More...
 
virtual ~Graphic3d_HighlightStyle ()
 Deletes color pointer stored for consistency with TKOpenGl. More...
 
void SetMethod (const Aspect_TypeOfHighlightMethod theMethod)
 Changes current highlight method to the given one. More...
 
Aspect_TypeOfHighlightMethod Method () const
 Returns current highlight method. More...
 
void SetColor (const Quantity_Color &theColor)
 Changes highlight color to the given one. More...
 
const Quantity_ColorColor () const
 Returns current highlight color. More...
 
void SetTransparency (const Standard_ShortReal theTranspCoef)
 Changes transparency of a highlight presentation to the given one. More...
 
Standard_ShortReal Transparency () const
 Returns current transparency of a highlight presentation. More...
 
const Graphic3d_Vec4ColorFltPtr () const
 Returns pointer to current highlight color in RGBA format. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

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

Detailed Description

A class for setting up highlight properties, such as:

Constructor & Destructor Documentation

Graphic3d_HighlightStyle::Graphic3d_HighlightStyle ( const Aspect_TypeOfHighlightMethod  theMethod = Aspect_TOHM_COLOR,
const Quantity_Color theColor = Quantity_NOC_WHITE,
const Standard_ShortReal  theTransparency = 0.f 
)
inline

Creates the style. Default parameters are:

  • method: color;
  • color: white;
  • transparency: 0.f.
Graphic3d_HighlightStyle::Graphic3d_HighlightStyle ( const Handle< Graphic3d_HighlightStyle > &  theOther)
inline

Creates a copy of the given style.

virtual Graphic3d_HighlightStyle::~Graphic3d_HighlightStyle ( )
inlinevirtual

Deletes color pointer stored for consistency with TKOpenGl.

Member Function Documentation

const Quantity_Color& Graphic3d_HighlightStyle::Color ( ) const
inline

Returns current highlight color.

const Graphic3d_Vec4* Graphic3d_HighlightStyle::ColorFltPtr ( ) const
inline

Returns pointer to current highlight color in RGBA format.

Aspect_TypeOfHighlightMethod Graphic3d_HighlightStyle::Method ( ) const
inline

Returns current highlight method.

void Graphic3d_HighlightStyle::SetColor ( const Quantity_Color theColor)
inline

Changes highlight color to the given one.

void Graphic3d_HighlightStyle::SetMethod ( const Aspect_TypeOfHighlightMethod  theMethod)
inline

Changes current highlight method to the given one.

void Graphic3d_HighlightStyle::SetTransparency ( const Standard_ShortReal  theTranspCoef)
inline

Changes transparency of a highlight presentation to the given one.

Standard_ShortReal Graphic3d_HighlightStyle::Transparency ( ) const
inline

Returns current transparency of a highlight presentation.


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