XCAFPrs_Style Class Reference

Represents a set of styling settings applicable to a (sub)shape. More...

#include <XCAFPrs_Style.hxx>

Public Member Functions
	XCAFPrs_Style ()
	Empty constructor - colors are unset, visibility is TRUE.
bool	IsEmpty () const
	Return TRUE if style is empty - does not override any properties.
const occ::handle< XCAFDoc_VisMaterial > &	Material () const
	Return material.
void	SetMaterial (const occ::handle< XCAFDoc_VisMaterial > &theMaterial)
	Set material.
bool	IsSetColorSurf () const
	Return TRUE if surface color has been defined.
const Quantity_Color &	GetColorSurf () const
	Return surface color.
void	SetColorSurf (const Quantity_Color &theColor)
	Set surface color.
const Quantity_ColorRGBA &	GetColorSurfRGBA () const
	Return surface color.
void	SetColorSurf (const Quantity_ColorRGBA &theColor)
	Set surface color.
void	UnSetColorSurf ()
	Manage surface color setting.
bool	IsSetColorCurv () const
	Return TRUE if curve color has been defined.
const Quantity_Color &	GetColorCurv () const
	Return curve color.
void	SetColorCurv (const Quantity_Color &col)
	Set curve color.
void	UnSetColorCurv ()
	Manage curve color setting.
void	SetVisibility (const bool theVisibility)
	Assign visibility.
bool	IsVisible () const
	Manage visibility.
const occ::handle< Image_Texture > &	BaseColorTexture () const
	Return base color texture.
bool	IsEqual (const XCAFPrs_Style &theOther) const
	Returns True if styles are the same Methods for using Style as key in maps.
bool	operator== (const XCAFPrs_Style &theOther) const
	Returns True if styles are the same.
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

Protected Attributes
occ::handle< XCAFDoc_VisMaterial >	myMaterial
Quantity_ColorRGBA	myColorSurf
Quantity_Color	myColorCurv
bool	myHasColorSurf
bool	myHasColorCurv
bool	myIsVisible

Detailed Description

Represents a set of styling settings applicable to a (sub)shape.

Constructor & Destructor Documentation

XCAFPrs_Style()

XCAFPrs_Style::XCAFPrs_Style

(

)

Empty constructor - colors are unset, visibility is TRUE.

Member Function Documentation

BaseColorTexture()

const occ::handle< Image_Texture > & XCAFPrs_Style::BaseColorTexture ( ) const

inline

Return base color texture.

DumpJson()

void XCAFPrs_Style::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

Dumps the content of me into the stream.

GetColorCurv()

const Quantity_Color & XCAFPrs_Style::GetColorCurv ( ) const

inline

Return curve color.

GetColorSurf()

const Quantity_Color & XCAFPrs_Style::GetColorSurf ( ) const

inline

Return surface color.

GetColorSurfRGBA()

const Quantity_ColorRGBA & XCAFPrs_Style::GetColorSurfRGBA ( ) const

inline

Return surface color.

IsEmpty()

bool XCAFPrs_Style::IsEmpty ( ) const

inline

Return TRUE if style is empty - does not override any properties.

IsEqual()

bool XCAFPrs_Style::IsEqual ( const XCAFPrs_Style & theOther ) const

inline

Returns True if styles are the same Methods for using Style as key in maps.

IsSetColorCurv()

bool XCAFPrs_Style::IsSetColorCurv ( ) const

inline

Return TRUE if curve color has been defined.

IsSetColorSurf()

bool XCAFPrs_Style::IsSetColorSurf ( ) const

inline

Return TRUE if surface color has been defined.

IsVisible()

bool XCAFPrs_Style::IsVisible ( ) const

inline

Manage visibility.

Material()

const occ::handle< XCAFDoc_VisMaterial > & XCAFPrs_Style::Material ( ) const

inline

Return material.

operator==()

bool XCAFPrs_Style::operator== ( const XCAFPrs_Style & theOther ) const

inline

Returns True if styles are the same.

SetColorCurv()

void XCAFPrs_Style::SetColorCurv

(

const Quantity_Color &

col

)

Set curve color.

SetColorSurf() [1/2]

void XCAFPrs_Style::SetColorSurf ( const Quantity_Color & theColor )

inline

Set surface color.

SetColorSurf() [2/2]

void XCAFPrs_Style::SetColorSurf

(

const Quantity_ColorRGBA &

theColor

)

Set surface color.

SetMaterial()

void XCAFPrs_Style::SetMaterial ( const occ::handle< XCAFDoc_VisMaterial > & theMaterial )

inline

Set material.

SetVisibility()

void XCAFPrs_Style::SetVisibility ( const bool theVisibility )

inline

Assign visibility.

UnSetColorCurv()

void XCAFPrs_Style::UnSetColorCurv

(

)

Manage curve color setting.

UnSetColorSurf()

void XCAFPrs_Style::UnSetColorSurf

(

)

Manage surface color setting.

Field Documentation

myColorCurv

Quantity_Color XCAFPrs_Style::myColorCurv

protected

myColorSurf

Quantity_ColorRGBA XCAFPrs_Style::myColorSurf

protected

myHasColorCurv

bool XCAFPrs_Style::myHasColorCurv

protected

myHasColorSurf

bool XCAFPrs_Style::myHasColorSurf

protected

myIsVisible

bool XCAFPrs_Style::myIsVisible

protected

myMaterial

occ::handle<XCAFDoc_VisMaterial> XCAFPrs_Style::myMaterial

protected

---

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

• XCAFPrs_Style.hxx