Graphic3d_SequenceOfHClipPlane Class Reference

Class defining the sequence of clipping planes. More...

#include <Graphic3d_SequenceOfHClipPlane.hxx>

Inheritance diagram for Graphic3d_SequenceOfHClipPlane:

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...
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...
Standard_Transient &	operator= (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_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. 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...
Public Member Functions inherited from NCollection_Sequence< Handle< Graphic3d_ClipPlane > >
iterator	begin () const
	Returns an iterator pointing to the first element in the sequence. More...
iterator	end () const
	Returns an iterator referring to the past-the-end element in the sequence. More...
const_iterator	cbegin () const
	Returns a const iterator pointing to the first element in the sequence. More...
const_iterator	cend () const
	Returns a const iterator referring to the past-the-end element in the sequence. More...
	NCollection_Sequence ()
	Empty constructor. More...
	NCollection_Sequence (const Handle< NCollection_BaseAllocator > &theAllocator)
	Constructor. More...
	NCollection_Sequence (const NCollection_Sequence &theOther)
	Copy constructor. More...
Standard_Integer	Size (void) const
	Number of items. More...
Standard_Integer	Length (void) const
	Number of items. More...
Standard_Integer	Lower () const
	Method for consistency with other collections. More...
Standard_Integer	Upper () const
	Method for consistency with other collections. More...
Standard_Boolean	IsEmpty (void) const
	Empty query. More...
void	Reverse (void)
	Reverse sequence. More...
void	Exchange (const Standard_Integer I, const Standard_Integer J)
	Exchange two members. More...
void	Clear (const Handle< NCollection_BaseAllocator > &theAllocator=0L)
	Clear the items out, take a new allocator if non null. More...
NCollection_Sequence &	Assign (const NCollection_Sequence &theOther)
	Replace this sequence by the items of theOther. This method does not change the internal allocator. More...
NCollection_Sequence &	operator= (const NCollection_Sequence &theOther)
	Replacement operator. More...
void	Remove (Iterator &thePosition)
	Remove one item. More...
void	Remove (const Standard_Integer theIndex)
	Remove one item. More...
void	Remove (const Standard_Integer theFromIndex, const Standard_Integer theToIndex)
	Remove range of items. More...
void	Append (const Handle< Graphic3d_ClipPlane > &theItem)
	Append one item. More...
void	Append (NCollection_Sequence &theSeq)
	Append another sequence (making it empty) More...
void	Prepend (const Handle< Graphic3d_ClipPlane > &theItem)
	Prepend one item. More...
void	Prepend (NCollection_Sequence &theSeq)
	Prepend another sequence (making it empty) More...
void	InsertBefore (const Standard_Integer theIndex, const Handle< Graphic3d_ClipPlane > &theItem)
	InsertBefore theIndex theItem. More...
void	InsertBefore (const Standard_Integer theIndex, NCollection_Sequence &theSeq)
	InsertBefore theIndex another sequence. More...
void	InsertAfter (Iterator &thePosition, const Handle< Graphic3d_ClipPlane > &theItem)
	InsertAfter the position of iterator. More...
void	InsertAfter (const Standard_Integer theIndex, NCollection_Sequence &theSeq)
	InsertAfter theIndex theItem. More...
void	InsertAfter (const Standard_Integer theIndex, const Handle< Graphic3d_ClipPlane > &theItem)
	InsertAfter theIndex another sequence. More...
void	Split (const Standard_Integer theIndex, NCollection_Sequence &theSeq)
	Split in two sequences. More...
const Handle< Graphic3d_ClipPlane > &	First () const
	First item access. More...
Handle< Graphic3d_ClipPlane > &	ChangeFirst ()
	First item access. More...
const Handle< Graphic3d_ClipPlane > &	Last () const
	Last item access. More...
Handle< Graphic3d_ClipPlane > &	ChangeLast ()
	Last item access. More...
const Handle< Graphic3d_ClipPlane > &	Value (const Standard_Integer theIndex) const
	Constant item access by theIndex. More...
const Handle< Graphic3d_ClipPlane > &	operator() (const Standard_Integer theIndex) const
	Constant operator() More...
Handle< Graphic3d_ClipPlane > &	operator() (const Standard_Integer theIndex)
	Variable operator() More...
Handle< Graphic3d_ClipPlane > &	ChangeValue (const Standard_Integer theIndex)
	Variable item access by theIndex. More...
void	SetValue (const Standard_Integer theIndex, const Handle< Graphic3d_ClipPlane > &theItem)
	Set item value by theIndex. More...
virtual	~NCollection_Sequence (void)
Public Member Functions inherited from NCollection_BaseSequence
Standard_Boolean	IsEmpty () const
Standard_Integer	Length () const
const Handle< NCollection_BaseAllocator > &	Allocator () const
	Returns attached allocator. More...

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...
Public Types inherited from NCollection_Sequence< Handle< Graphic3d_ClipPlane > >
typedef Handle< Graphic3d_ClipPlane >	value_type
	STL-compliant typedef for value type. More...
typedef NCollection_StlIterator< std::bidirectional_iterator_tag, Iterator, Handle< Graphic3d_ClipPlane >, false >	iterator
	Shorthand for a regular iterator type. More...
typedef NCollection_StlIterator< std::bidirectional_iterator_tag, Iterator, Handle< Graphic3d_ClipPlane >, true >	const_iterator
	Shorthand for a constant iterator type. 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...
Static Public Member Functions inherited from NCollection_Sequence< Handle< Graphic3d_ClipPlane > >
static void	delNode (NCollection_SeqNode *theNode, Handle< NCollection_BaseAllocator > &theAl)
	Static deleter to be passed to BaseSequence. More...
Protected Member Functions inherited from NCollection_BaseSequence
	NCollection_BaseSequence (const Handle< NCollection_BaseAllocator > &theAllocator)
virtual	~NCollection_BaseSequence ()
	Destructor. More...
void	ClearSeq (NCollection_DelSeqNode fDel)
void	PAppend (NCollection_SeqNode *)
void	PAppend (NCollection_BaseSequence &S)
void	PPrepend (NCollection_SeqNode *)
void	PPrepend (NCollection_BaseSequence &S)
void	PInsertAfter (Iterator &thePosition, NCollection_SeqNode *)
void	PInsertAfter (const Standard_Integer Index, NCollection_SeqNode *)
void	PInsertAfter (const Standard_Integer Index, NCollection_BaseSequence &S)
void	PSplit (const Standard_Integer Index, NCollection_BaseSequence &Sub)
void	RemoveSeq (Iterator &thePosition, NCollection_DelSeqNode fDel)
void	RemoveSeq (const Standard_Integer Index, NCollection_DelSeqNode fDel)
void	RemoveSeq (const Standard_Integer From, const Standard_Integer To, NCollection_DelSeqNode fDel)
void	PReverse ()
void	PExchange (const Standard_Integer I, const Standard_Integer J)
NCollection_SeqNode *	Find (const Standard_Integer) const
Protected Attributes inherited from NCollection_BaseSequence
Handle< NCollection_BaseAllocator >	myAllocator
NCollection_SeqNode *	myFirstItem
NCollection_SeqNode *	myLastItem
NCollection_SeqNode *	myCurrentItem
Standard_Integer	myCurrentIndex
Standard_Integer	mySize

Detailed Description

Class defining the sequence of clipping planes.

Constructor & Destructor Documentation

Graphic3d_SequenceOfHClipPlane()

Graphic3d_SequenceOfHClipPlane::Graphic3d_SequenceOfHClipPlane ( )

inline

Empty constructor.

Member Function Documentation

SetOverrideGlobal()

void Graphic3d_SequenceOfHClipPlane::SetOverrideGlobal ( const Standard_Boolean  theToOverride )

inline

Setup flag defining if local properties should override global properties.

ToOverrideGlobal()

Standard_Boolean Graphic3d_SequenceOfHClipPlane::ToOverrideGlobal ( ) const

inline

Return true if local properties should override global properties.

---

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

• Graphic3d_SequenceOfHClipPlane.hxx