Structure defines list of ZLayer properties. More...

#include <Graphic3d_ZLayerSettings.hxx>

Public Member Functions
	Graphic3d_ZLayerSettings ()
	Default settings. More...

const TCollection_AsciiString &	Name () const
	Return user-provided name. More...

void	SetName (const TCollection_AsciiString &theName)
	Set custom name. More...

const gp_XYZ &	Origin () const
	Return the origin of all objects within the layer. More...

const Handle< Geom_Transformation > &	OriginTransformation () const
	Return the transformation to the origin. More...

void	SetOrigin (const gp_XYZ &theOrigin)
	Set the origin of all objects within the layer. More...

Standard_Boolean	IsImmediate () const
	Return true if this layer should be drawn after all normal (non-immediate) layers. More...

void	SetImmediate (const Standard_Boolean theValue)
	Set the flag indicating the immediate layer, which should be drawn after all normal (non-immediate) layers. More...

Standard_Boolean	UseEnvironmentTexture () const
	Return flag to allow/prevent environment texture mapping usage for specific layer. More...

void	SetEnvironmentTexture (const Standard_Boolean theValue)
	Set the flag to allow/prevent environment texture mapping usage for specific layer. More...

Standard_Boolean	ToEnableDepthTest () const
	Return true if depth test should be enabled. More...

void	SetEnableDepthTest (const Standard_Boolean theValue)
	Set if depth test should be enabled. More...

Standard_Boolean	ToEnableDepthWrite () const
	Return true depth values should be written during rendering. More...

void	SetEnableDepthWrite (const Standard_Boolean theValue)
	Set if depth values should be written during rendering. More...

Standard_Boolean	ToClearDepth () const
	Return true if depth values should be cleared before drawing the layer. More...

void	SetClearDepth (const Standard_Boolean theValue)
	Set if depth values should be cleared before drawing the layer. More...

const Graphic3d_PolygonOffset &	PolygonOffset () const
	Return glPolygonOffset() arguments. More...

void	SetPolygonOffset (const Graphic3d_PolygonOffset &theParams)
	Setup glPolygonOffset() arguments. More...

Graphic3d_PolygonOffset &	ChangePolygonOffset ()
	Modify glPolygonOffset() arguments. More...

	Standard_DEPRECATED ("Deprecated method IsSettingEnabled() should be replaced by individual property getters") Standard_Boolean IsSettingEnabled(const Graphic3d_ZLayerSetting theSetting) const
	Returns true if theSetting is enabled. More...

	Standard_DEPRECATED ("Deprecated method EnableSetting() should be replaced by individual property getters") void EnableSetting(const Graphic3d_ZLayerSetting theSetting)
	Enables theSetting. More...

	Standard_DEPRECATED ("Deprecated method DisableSetting() should be replaced by individual property getters") void DisableSetting(const Graphic3d_ZLayerSetting theSetting)
	Disables theSetting. More...

void	SetDepthOffsetPositive ()
	Sets minimal possible positive depth offset. More...

void	SetDepthOffsetNegative ()
	Sets minimal possible negative depth offset. More...

Protected Attributes
TCollection_AsciiString	myName
	user-provided name More...

Handle< Geom_Transformation >	myOriginTrsf
	transformation to the origin More...

gp_XYZ	myOrigin
	the origin of all objects within the layer More...

Graphic3d_PolygonOffset	myPolygonOffset
	glPolygonOffset() arguments More...

Standard_Boolean	myIsImmediate
	immediate layer will be drawn after all normal layers More...

Standard_Boolean	myUseEnvironmentTexture
	flag to allow/prevent environment texture mapping usage for specific layer More...

Standard_Boolean	myToEnableDepthTest
	option to enable depth test More...

Standard_Boolean	myToEnableDepthWrite
	option to enable write depth values More...

Standard_Boolean	myToClearDepth
	option to clear depth values before drawing the layer More...

Detailed Description

Structure defines list of ZLayer properties.

Constructor & Destructor Documentation

◆ Graphic3d_ZLayerSettings()

Graphic3d_ZLayerSettings::Graphic3d_ZLayerSettings ( )

inline

Default settings.

Member Function Documentation

◆ ChangePolygonOffset()

Graphic3d_PolygonOffset& Graphic3d_ZLayerSettings::ChangePolygonOffset ( )

inline

Modify glPolygonOffset() arguments.

◆ IsImmediate()

Standard_Boolean Graphic3d_ZLayerSettings::IsImmediate ( ) const

inline

Return true if this layer should be drawn after all normal (non-immediate) layers.

◆ Name()

const TCollection_AsciiString& Graphic3d_ZLayerSettings::Name ( ) const

inline

Return user-provided name.

◆ Origin()

const gp_XYZ& Graphic3d_ZLayerSettings::Origin ( ) const

inline

Return the origin of all objects within the layer.

◆ OriginTransformation()

const Handle< Geom_Transformation >& Graphic3d_ZLayerSettings::OriginTransformation ( ) const

inline

Return the transformation to the origin.

◆ PolygonOffset()

const Graphic3d_PolygonOffset& Graphic3d_ZLayerSettings::PolygonOffset ( ) const

inline

Return glPolygonOffset() arguments.

◆ SetClearDepth()

void Graphic3d_ZLayerSettings::SetClearDepth ( const Standard_Boolean theValue )

inline

Set if depth values should be cleared before drawing the layer.

◆ SetDepthOffsetNegative()

void Graphic3d_ZLayerSettings::SetDepthOffsetNegative ( )

inline

Sets minimal possible negative depth offset.

◆ SetDepthOffsetPositive()

void Graphic3d_ZLayerSettings::SetDepthOffsetPositive ( )

inline

Sets minimal possible positive depth offset.

◆ SetEnableDepthTest()

void Graphic3d_ZLayerSettings::SetEnableDepthTest ( const Standard_Boolean theValue )

inline

Set if depth test should be enabled.

◆ SetEnableDepthWrite()

void Graphic3d_ZLayerSettings::SetEnableDepthWrite ( const Standard_Boolean theValue )

inline

Set if depth values should be written during rendering.

◆ SetEnvironmentTexture()

void Graphic3d_ZLayerSettings::SetEnvironmentTexture ( const Standard_Boolean theValue )

inline

Set the flag to allow/prevent environment texture mapping usage for specific layer.

◆ SetImmediate()

void Graphic3d_ZLayerSettings::SetImmediate ( const Standard_Boolean theValue )

inline

Set the flag indicating the immediate layer, which should be drawn after all normal (non-immediate) layers.

◆ SetName()

void Graphic3d_ZLayerSettings::SetName ( const TCollection_AsciiString & theName )

inline

Set custom name.

◆ SetOrigin()

void Graphic3d_ZLayerSettings::SetOrigin ( const gp_XYZ & theOrigin )

inline

Set the origin of all objects within the layer.

◆ SetPolygonOffset()

void Graphic3d_ZLayerSettings::SetPolygonOffset ( const Graphic3d_PolygonOffset & theParams )

inline

Setup glPolygonOffset() arguments.

◆ Standard_DEPRECATED() [1/3]

Graphic3d_ZLayerSettings::Standard_DEPRECATED ( "Deprecated method IsSettingEnabled() should be replaced by individual property getters" ) const

inline

Returns true if theSetting is enabled.

◆ Standard_DEPRECATED() [2/3]

Graphic3d_ZLayerSettings::Standard_DEPRECATED ( "Deprecated method EnableSetting() should be replaced by individual property getters" ) const

inline

Enables theSetting.

◆ Standard_DEPRECATED() [3/3]

Graphic3d_ZLayerSettings::Standard_DEPRECATED ( "Deprecated method DisableSetting() should be replaced by individual property getters" ) const

inline

Disables theSetting.

◆ ToClearDepth()

Standard_Boolean Graphic3d_ZLayerSettings::ToClearDepth ( ) const

inline

Return true if depth values should be cleared before drawing the layer.

◆ ToEnableDepthTest()

Standard_Boolean Graphic3d_ZLayerSettings::ToEnableDepthTest ( ) const

inline

Return true if depth test should be enabled.

◆ ToEnableDepthWrite()

Standard_Boolean Graphic3d_ZLayerSettings::ToEnableDepthWrite ( ) const

inline

Return true depth values should be written during rendering.

◆ UseEnvironmentTexture()

Standard_Boolean Graphic3d_ZLayerSettings::UseEnvironmentTexture ( ) const

inline

Return flag to allow/prevent environment texture mapping usage for specific layer.

Field Documentation

◆ myIsImmediate

Standard_Boolean Graphic3d_ZLayerSettings::myIsImmediate

protected

immediate layer will be drawn after all normal layers

◆ myName

TCollection_AsciiString Graphic3d_ZLayerSettings::myName

protected

user-provided name

◆ myOrigin

gp_XYZ Graphic3d_ZLayerSettings::myOrigin

protected

the origin of all objects within the layer

◆ myOriginTrsf

Handle< Geom_Transformation > Graphic3d_ZLayerSettings::myOriginTrsf

protected

transformation to the origin

◆ myPolygonOffset

Graphic3d_PolygonOffset Graphic3d_ZLayerSettings::myPolygonOffset

protected

glPolygonOffset() arguments

◆ myToClearDepth

Standard_Boolean Graphic3d_ZLayerSettings::myToClearDepth

protected

option to clear depth values before drawing the layer

◆ myToEnableDepthTest

Standard_Boolean Graphic3d_ZLayerSettings::myToEnableDepthTest

protected

option to enable depth test

◆ myToEnableDepthWrite

Standard_Boolean Graphic3d_ZLayerSettings::myToEnableDepthWrite

protected

option to enable write depth values

◆ myUseEnvironmentTexture

Standard_Boolean Graphic3d_ZLayerSettings::myUseEnvironmentTexture

protected

flag to allow/prevent environment texture mapping usage for specific layer

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

Graphic3d_ZLayerSettings.hxx

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_ZLayerSettings()

Member Function Documentation

◆ ChangePolygonOffset()

◆ IsImmediate()

◆ Name()

◆ Origin()

◆ OriginTransformation()

◆ PolygonOffset()

◆ SetClearDepth()

◆ SetDepthOffsetNegative()

◆ SetDepthOffsetPositive()

◆ SetEnableDepthTest()

◆ SetEnableDepthWrite()

◆ SetEnvironmentTexture()

◆ SetImmediate()

◆ SetName()

◆ SetOrigin()

◆ SetPolygonOffset()

◆ Standard_DEPRECATED() [1/3]

◆ Standard_DEPRECATED() [2/3]

◆ Standard_DEPRECATED() [3/3]

◆ ToClearDepth()

◆ ToEnableDepthTest()

◆ ToEnableDepthWrite()

◆ UseEnvironmentTexture()

Field Documentation

◆ myIsImmediate

◆ myName

◆ myOrigin

◆ myOriginTrsf

◆ myPolygonOffset

◆ myToClearDepth

◆ myToEnableDepthTest

◆ myToEnableDepthWrite

◆ myUseEnvironmentTexture