Open CASCADE Technology  7.3.1.dev
Data Structures | Public Member Functions | Protected Attributes
Graphic3d_SequenceOfHClipPlane Class Reference

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:
Inheritance graph
[legend]

Data Structures

class  Iterator
 Iterator through clipping planes. More...
 

Public Member Functions

 Graphic3d_SequenceOfHClipPlane ()
 Empty constructor. More...
 
Standard_Boolean ToOverrideGlobal () const
 Return true if local properties should override global properties. More...
 
void SetOverrideGlobal (const Standard_Boolean theToOverride)
 Setup flag defining if local properties should override global properties. More...
 
bool IsEmpty () const
 Return TRUE if sequence is empty. More...
 
Standard_Integer Size () const
 Return the number of items in sequence. More...
 
bool Append (const Handle< Graphic3d_ClipPlane > &theItem)
 Append a plane. More...
 
bool Remove (const Handle< Graphic3d_ClipPlane > &theItem)
 Remove a plane. More...
 
void Remove (Iterator &theItem)
 Remove a plane. More...
 
void Clear ()
 Clear the items out. More...
 
const Handle< Graphic3d_ClipPlane > & First () const
 Return the first item in sequence. 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...
 

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. 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

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.

◆ 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 ( void  ) 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: