Class defines a Clipping Volume as a logical OR (disjunction) operation between Graphic3d_ClipPlane in sequence. Each Graphic3d_ClipPlane represents either a single Plane clipping a halfspace (direction is specified by normal), or a sub-chain of planes defining a logical AND (conjunction) operation. Therefore, this collection allows defining a Clipping Volume through the limited set of Boolean operations between clipping Planes. More...

#include <Graphic3d_SequenceOfHClipPlane.hxx>

Inheritance diagram for Graphic3d_SequenceOfHClipPlane:

[legend]

Data Structures
class	Iterator
	Iterator through clipping planes. More...

Public Member Functions
	Graphic3d_SequenceOfHClipPlane ()
	Empty constructor.

Standard_Boolean	ToOverrideGlobal () const
	Return true if local properties should override global properties.

void	SetOverrideGlobal (const Standard_Boolean theToOverride)
	Setup flag defining if local properties should override global properties.

bool	IsEmpty () const
	Return TRUE if sequence is empty.

Standard_Integer	Size () const
	Return the number of items in sequence.

bool	Append (const Handle< Graphic3d_ClipPlane > &theItem)
	Append a plane.

bool	Remove (const Handle< Graphic3d_ClipPlane > &theItem)
	Remove a plane.

void	Remove (Iterator &theItem)
	Remove a plane.

void	Clear ()
	Clear the items out.

const Handle< Graphic3d_ClipPlane > &	First () const
	Return the first item in sequence.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer 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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
NCollection_Sequence< Handle< Graphic3d_ClipPlane > >	myItems

Standard_Boolean	myToOverrideGlobal

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 a Clipping Volume as a logical OR (disjunction) operation between Graphic3d_ClipPlane in sequence. Each Graphic3d_ClipPlane represents either a single Plane clipping a halfspace (direction is specified by normal), or a sub-chain of planes defining a logical AND (conjunction) operation. Therefore, this collection allows defining a Clipping Volume through the limited set of Boolean operations between clipping Planes.

The Clipping Volume can be assigned either to entire View or to a specific Object; in the latter case property ToOverrideGlobal() will specify if Object planes should override (suppress) globally defined ones or extend their definition through logical OR (disjunction) operation.

Note that defining (many) planes will lead to performance degradation, and Graphics Driver may limit the overall number of simultaneously active clipping planes - but at least 6 planes should be supported on all configurations.

Constructor & Destructor Documentation

◆ Graphic3d_SequenceOfHClipPlane()

Graphic3d_SequenceOfHClipPlane::Graphic3d_SequenceOfHClipPlane ( )

Empty constructor.

Member Function Documentation

◆ Append()

bool Graphic3d_SequenceOfHClipPlane::Append ( const Handle< Graphic3d_ClipPlane > & theItem )

Append a plane.

Returns: TRUE if new item has been added (FALSE if item already existed)

◆ Clear()

void Graphic3d_SequenceOfHClipPlane::Clear ( )

inline

Clear the items out.

◆ DumpJson()

virtual void Graphic3d_SequenceOfHClipPlane::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

virtual

Dumps the content of me into the stream.

◆ First()

const Handle< Graphic3d_ClipPlane > & Graphic3d_SequenceOfHClipPlane::First ( ) const

inline

Return the first item in sequence.

◆ IsEmpty()

bool Graphic3d_SequenceOfHClipPlane::IsEmpty ( ) const

inline

Return TRUE if sequence is empty.

◆ Remove() [1/2]

bool Graphic3d_SequenceOfHClipPlane::Remove ( const Handle< Graphic3d_ClipPlane > & theItem )

Remove a plane.

Returns: TRUE if item has been found and removed

◆ Remove() [2/2]

void Graphic3d_SequenceOfHClipPlane::Remove ( Iterator & theItem )

inline

Remove a plane.

◆ SetOverrideGlobal()

void Graphic3d_SequenceOfHClipPlane::SetOverrideGlobal ( const Standard_Boolean theToOverride )

inline

Setup flag defining if local properties should override global properties.

◆ Size()

Standard_Integer Graphic3d_SequenceOfHClipPlane::Size ( ) const

inline

Return the number of items in sequence.

◆ ToOverrideGlobal()

Standard_Boolean Graphic3d_SequenceOfHClipPlane::ToOverrideGlobal ( ) const

inline

Return true if local properties should override global properties.

Field Documentation

◆ myItems

NCollection_Sequence<Handle< Graphic3d_ClipPlane > > Graphic3d_SequenceOfHClipPlane::myItems

protected

◆ myToOverrideGlobal

Standard_Boolean Graphic3d_SequenceOfHClipPlane::myToOverrideGlobal

protected

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

Graphic3d_SequenceOfHClipPlane.hxx

Data Structures

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_SequenceOfHClipPlane()

Member Function Documentation

◆ Append()

◆ Clear()

◆ DumpJson()

◆ First()

◆ IsEmpty()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetOverrideGlobal()

◆ Size()

◆ ToOverrideGlobal()

Field Documentation

◆ myItems

◆ myToOverrideGlobal