Class for working with STEP rendering properties. Provides functionality to create and manipulate rendering properties used for specifying visual appearance in STEP format. This class handles both parsing of STEP entities and creation of new ones. More...

#include <STEPConstruct_RenderingProperties.hxx>

Public Member Functions
	STEPConstruct_RenderingProperties ()
	Default constructor creating an empty rendering properties object.

	STEPConstruct_RenderingProperties (const occ::handle< StepVisual_SurfaceStyleRenderingWithProperties > &theRenderingProperties)
	Constructor from STEP rendering properties entity. Extracts color, transparency, and other properties from the STEP entity.

	STEPConstruct_RenderingProperties (const Quantity_ColorRGBA &theRGBAColor)
	Constructor from RGBA color. Creates rendering properties with the given color and transparency.

	STEPConstruct_RenderingProperties (const occ::handle< StepVisual_Colour > &theColor, const double theTransparency)
	Constructor from STEP color and transparency value. Creates rendering properties with the given color and transparency.

	STEPConstruct_RenderingProperties (const XCAFDoc_VisMaterialCommon &theMaterial)
	Constructor from XCAFDoc_VisMaterialCommon. Creates rendering properties using material properties from the OCCT material.

	STEPConstruct_RenderingProperties (const occ::handle< XCAFDoc_VisMaterial > &theMaterial)
	Constructor from XCAFDoc_VisMaterial. Creates rendering properties using material properties from the OCCT material.

	STEPConstruct_RenderingProperties (const Quantity_Color &theSurfaceColor, const double theTransparency=0.0)
	Constructor from surface color, transparency, and rendering method.

void	Init (const occ::handle< StepVisual_SurfaceStyleRenderingWithProperties > &theRenderingProperties)
	Initializes from STEP rendering properties entity. Extracts color, transparency, and other properties from the STEP entity.

void	Init (const Quantity_ColorRGBA &theRGBAColor)
	Initializes from RGBA color.

void	Init (const occ::handle< StepVisual_Colour > &theColor, const double theTransparency)
	Initializes from STEP color and transparency value.

void	Init (const XCAFDoc_VisMaterialCommon &theMaterial)
	Initializes from XCAFDoc_VisMaterialCommon.

void	Init (const occ::handle< XCAFDoc_VisMaterial > &theMaterial)
	Initializes from XCAFDoc_VisMaterial.

void	Init (const Quantity_Color &theSurfaceColor, const double theTransparency=0.0)
	Initializes from surface color, transparency and rendering method.

void	SetAmbientReflectance (const double theAmbientReflectance)
	Sets ambient reflectance value.

void	SetAmbientAndDiffuseReflectance (const double theAmbientReflectance, const double theDiffuseReflectance)
	Sets ambient and diffuse reflectance values.

void	SetAmbientDiffuseAndSpecularReflectance (const double theAmbientReflectance, const double theDiffuseReflectance, const double theSpecularReflectance, const double theSpecularExponent, const Quantity_Color &theSpecularColour)
	Sets ambient, diffuse and specular reflectance values.

occ::handle< StepVisual_SurfaceStyleRenderingWithProperties >	CreateRenderingProperties () const
	Creates and returns rendering properties entity.

occ::handle< StepVisual_SurfaceStyleRenderingWithProperties >	CreateRenderingProperties (const occ::handle< StepVisual_Colour > &theRenderColour) const

XCAFDoc_VisMaterialCommon	CreateXCAFMaterial () const
	Creates and returns XCAF material entity.

Quantity_ColorRGBA	GetRGBAColor () const
	Creates the ColorRGBA object from the current color and transparency.

Quantity_Color	SurfaceColor () const
	Returns surface color.

double	Transparency () const
	Returns transparency value.

StepVisual_ShadingSurfaceMethod	RenderingMethod () const
	Returns rendering method.

void	SetRenderingMethod (const StepVisual_ShadingSurfaceMethod theRenderingMethod)
	Sets rendering method.

bool	IsDefined () const
	Returns whether the rendering properties are defined.

bool	IsMaterialConvertible () const
	Returns whether material is convertible to STEP.

double	AmbientReflectance () const
	Returns ambient reflectance value.

bool	IsAmbientReflectanceDefined () const
	Returns whether ambient reflectance is defined.

double	DiffuseReflectance () const
	Returns diffuse reflectance value.

bool	IsDiffuseReflectanceDefined () const
	Returns whether diffuse reflectance is defined.

double	SpecularReflectance () const
	Returns specular reflectance value.

bool	IsSpecularReflectanceDefined () const
	Returns whether specular reflectance is defined.

double	SpecularExponent () const
	Returns specular exponent value.

bool	IsSpecularExponentDefined () const
	Returns whether specular exponent is defined.

Quantity_Color	SpecularColour () const
	Returns specular color.

bool	IsSpecularColourDefined () const
	Returns whether specular color is defined.

Detailed Description

Class for working with STEP rendering properties. Provides functionality to create and manipulate rendering properties used for specifying visual appearance in STEP format. This class handles both parsing of STEP entities and creation of new ones.

Constructor & Destructor Documentation

◆ STEPConstruct_RenderingProperties() [1/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties ( )

Default constructor creating an empty rendering properties object.

◆ STEPConstruct_RenderingProperties() [2/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties ( const occ::handle< StepVisual_SurfaceStyleRenderingWithProperties > & theRenderingProperties )

Constructor from STEP rendering properties entity. Extracts color, transparency, and other properties from the STEP entity.

Parameters

[in] theRenderingProperties rendering properties entity

◆ STEPConstruct_RenderingProperties() [3/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties ( const Quantity_ColorRGBA & theRGBAColor )

Constructor from RGBA color. Creates rendering properties with the given color and transparency.

Parameters

[in] theRGBAColor color with transparency

◆ STEPConstruct_RenderingProperties() [4/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties	(	const occ::handle< StepVisual_Colour > &	theColor,
		const double	theTransparency )

Constructor from STEP color and transparency value. Creates rendering properties with the given color and transparency.

Parameters

[in]	theColor	color
[in]	theTransparency	transparency value

◆ STEPConstruct_RenderingProperties() [5/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties ( const XCAFDoc_VisMaterialCommon & theMaterial )

Constructor from XCAFDoc_VisMaterialCommon. Creates rendering properties using material properties from the OCCT material.

Parameters

[in] theMaterial common visualization material properties

◆ STEPConstruct_RenderingProperties() [6/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties ( const occ::handle< XCAFDoc_VisMaterial > & theMaterial )

Constructor from XCAFDoc_VisMaterial. Creates rendering properties using material properties from the OCCT material.

Parameters

[in] theMaterial visualization material properties

◆ STEPConstruct_RenderingProperties() [7/7]

STEPConstruct_RenderingProperties::STEPConstruct_RenderingProperties	(	const Quantity_Color &	theSurfaceColor,
		const double	theTransparency = 0.0 )

Constructor from surface color, transparency, and rendering method.

Parameters

[in]	theSurfaceColor	surface color
[in]	theTransparency	transparency value

Member Function Documentation

◆ AmbientReflectance()

double STEPConstruct_RenderingProperties::AmbientReflectance ( ) const

Returns ambient reflectance value.

Returns: ambient reflectance value

◆ CreateRenderingProperties() [1/2]

occ::handle< StepVisual_SurfaceStyleRenderingWithProperties > STEPConstruct_RenderingProperties::CreateRenderingProperties ( ) const

Creates and returns rendering properties entity.

Returns: created rendering properties entity

◆ CreateRenderingProperties() [2/2]

occ::handle< StepVisual_SurfaceStyleRenderingWithProperties > STEPConstruct_RenderingProperties::CreateRenderingProperties ( const occ::handle< StepVisual_Colour > & theRenderColour ) const

Parameters

[in] theRenderColour color to be used for rendering

Returns: created rendering properties entity

◆ CreateXCAFMaterial()

XCAFDoc_VisMaterialCommon STEPConstruct_RenderingProperties::CreateXCAFMaterial ( ) const

Creates and returns XCAF material entity.

Returns: created XCAF material entity

◆ DiffuseReflectance()

double STEPConstruct_RenderingProperties::DiffuseReflectance ( ) const

Returns diffuse reflectance value.

Returns: diffuse reflectance value

◆ GetRGBAColor()

Quantity_ColorRGBA STEPConstruct_RenderingProperties::GetRGBAColor ( ) const

inline

Creates the ColorRGBA object from the current color and transparency.

Returns: ColorRGBA object

◆ Init() [1/6]

void STEPConstruct_RenderingProperties::Init	(	const occ::handle< StepVisual_Colour > &	theColor,
		const double	theTransparency )

Initializes from STEP color and transparency value.

Parameters

[in]	theColor	STEP color entity
[in]	theTransparency	transparency value

◆ Init() [2/6]

void STEPConstruct_RenderingProperties::Init ( const occ::handle< StepVisual_SurfaceStyleRenderingWithProperties > & theRenderingProperties )

Initializes from STEP rendering properties entity. Extracts color, transparency, and other properties from the STEP entity.

Parameters

[in] theRenderingProperties rendering properties entity

◆ Init() [3/6]

void STEPConstruct_RenderingProperties::Init ( const occ::handle< XCAFDoc_VisMaterial > & theMaterial )

Initializes from XCAFDoc_VisMaterial.

Parameters

[in] theMaterial visualization material properties

◆ Init() [4/6]

void STEPConstruct_RenderingProperties::Init	(	const Quantity_Color &	theSurfaceColor,
		const double	theTransparency = 0.0 )

Initializes from surface color, transparency and rendering method.

Parameters

[in]	theSurfaceColor	surface color
[in]	theTransparency	transparency value

◆ Init() [5/6]

void STEPConstruct_RenderingProperties::Init ( const Quantity_ColorRGBA & theRGBAColor )

Initializes from RGBA color.

Parameters

[in] theRGBAColor color with transparency

◆ Init() [6/6]

void STEPConstruct_RenderingProperties::Init ( const XCAFDoc_VisMaterialCommon & theMaterial )

Initializes from XCAFDoc_VisMaterialCommon.

Parameters

[in] theMaterial common visualization material properties

◆ IsAmbientReflectanceDefined()

bool STEPConstruct_RenderingProperties::IsAmbientReflectanceDefined ( ) const

Returns whether ambient reflectance is defined.

Returns: true if defined, false otherwise

◆ IsDefined()

bool STEPConstruct_RenderingProperties::IsDefined ( ) const

inline

Returns whether the rendering properties are defined.

Returns: true if defined, false otherwise

◆ IsDiffuseReflectanceDefined()

bool STEPConstruct_RenderingProperties::IsDiffuseReflectanceDefined ( ) const

Returns whether diffuse reflectance is defined.

Returns: true if defined, false otherwise

◆ IsMaterialConvertible()

bool STEPConstruct_RenderingProperties::IsMaterialConvertible ( ) const

Returns whether material is convertible to STEP.

Returns: true if fully defined for conversion, false otherwise

◆ IsSpecularColourDefined()

bool STEPConstruct_RenderingProperties::IsSpecularColourDefined ( ) const

Returns whether specular color is defined.

Returns: true if defined, false otherwise

◆ IsSpecularExponentDefined()

bool STEPConstruct_RenderingProperties::IsSpecularExponentDefined ( ) const

Returns whether specular exponent is defined.

Returns: true if defined, false otherwise

◆ IsSpecularReflectanceDefined()

bool STEPConstruct_RenderingProperties::IsSpecularReflectanceDefined ( ) const

Returns whether specular reflectance is defined.

Returns: true if defined, false otherwise

◆ RenderingMethod()

StepVisual_ShadingSurfaceMethod STEPConstruct_RenderingProperties::RenderingMethod ( ) const

inline

Returns rendering method.

Returns: rendering method

◆ SetAmbientAndDiffuseReflectance()

void STEPConstruct_RenderingProperties::SetAmbientAndDiffuseReflectance	(	const double	theAmbientReflectance,
		const double	theDiffuseReflectance )

Sets ambient and diffuse reflectance values.

Parameters

[in]	theAmbientReflectance	ambient reflectance value
[in]	theDiffuseReflectance	diffuse reflectance value

◆ SetAmbientDiffuseAndSpecularReflectance()

void STEPConstruct_RenderingProperties::SetAmbientDiffuseAndSpecularReflectance	(	const double	theAmbientReflectance,
		const double	theDiffuseReflectance,
		const double	theSpecularReflectance,
		const double	theSpecularExponent,
		const Quantity_Color &	theSpecularColour )

Sets ambient, diffuse and specular reflectance values.

Parameters

[in]	theAmbientReflectance	ambient reflectance value
[in]	theDiffuseReflectance	diffuse reflectance value
[in]	theSpecularReflectance	specular reflectance value
[in]	theSpecularExponent	specular exponent value
[in]	theSpecularColour	specular color

◆ SetAmbientReflectance()

void STEPConstruct_RenderingProperties::SetAmbientReflectance ( const double theAmbientReflectance )

Sets ambient reflectance value.

Parameters

[in] theAmbientReflectance ambient reflectance value

◆ SetRenderingMethod()

void STEPConstruct_RenderingProperties::SetRenderingMethod ( const StepVisual_ShadingSurfaceMethod theRenderingMethod )

inline

Sets rendering method.

Parameters

[in] theRenderingMethod rendering method

◆ SpecularColour()

Quantity_Color STEPConstruct_RenderingProperties::SpecularColour ( ) const

Returns specular color.

Returns: specular color

◆ SpecularExponent()

double STEPConstruct_RenderingProperties::SpecularExponent ( ) const

Returns specular exponent value.

Returns: specular exponent value

◆ SpecularReflectance()

double STEPConstruct_RenderingProperties::SpecularReflectance ( ) const

Returns specular reflectance value.

Returns: specular reflectance value

◆ SurfaceColor()

Quantity_Color STEPConstruct_RenderingProperties::SurfaceColor ( ) const

inline

Returns surface color.

Returns: surface color

◆ Transparency()

double STEPConstruct_RenderingProperties::Transparency ( ) const

inline

Returns transparency value.

Returns: transparency value

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

STEPConstruct_RenderingProperties.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ STEPConstruct_RenderingProperties() [1/7]

◆ STEPConstruct_RenderingProperties() [2/7]

◆ STEPConstruct_RenderingProperties() [3/7]

◆ STEPConstruct_RenderingProperties() [4/7]

◆ STEPConstruct_RenderingProperties() [5/7]

◆ STEPConstruct_RenderingProperties() [6/7]

◆ STEPConstruct_RenderingProperties() [7/7]

Member Function Documentation

◆ AmbientReflectance()

◆ CreateRenderingProperties() [1/2]

◆ CreateRenderingProperties() [2/2]

◆ CreateXCAFMaterial()

◆ DiffuseReflectance()

◆ GetRGBAColor()

◆ Init() [1/6]

◆ Init() [2/6]

◆ Init() [3/6]

◆ Init() [4/6]

◆ Init() [5/6]

◆ Init() [6/6]

◆ IsAmbientReflectanceDefined()

◆ IsDefined()

◆ IsDiffuseReflectanceDefined()

◆ IsMaterialConvertible()

◆ IsSpecularColourDefined()

◆ IsSpecularExponentDefined()

◆ IsSpecularReflectanceDefined()

◆ RenderingMethod()

◆ SetAmbientAndDiffuseReflectance()

◆ SetAmbientDiffuseAndSpecularReflectance()

◆ SetAmbientReflectance()

◆ SetRenderingMethod()

◆ SpecularColour()

◆ SpecularExponent()

◆ SpecularReflectance()

◆ SurfaceColor()

◆ Transparency()