Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

XCAFDoc_ViewTool Class Reference

Provides tools to store and retrieve Views in and from TDocStd_Document Each View contains parts XCAFDoc_View attribute with all information about camera and view window. Also each view contain information of displayed shapes and GDTs as sets of shape and GDT labels. More...

#include <XCAFDoc_ViewTool.hxx>

Inheritance diagram for XCAFDoc_ViewTool:
Inheritance graph
[legend]

Public Member Functions

 XCAFDoc_ViewTool ()
 
TDF_Label BaseLabel () const
 Returns the label under which Views are stored. More...
 
Standard_Boolean IsView (const TDF_Label &theLabel) const
 Returns True if label belongs to a View table and is a View definition. More...
 
void GetViewLabels (TDF_LabelSequence &theLabels) const
 Returns a sequence of View labels currently stored in the View table. More...
 
void SetView (const TDF_LabelSequence &theShapes, const TDF_LabelSequence &theGDTs, const TDF_LabelSequence &theClippingPlanes, const TDF_LabelSequence &theNotes, const TDF_LabelSequence &theAnnotations, const TDF_Label &theViewL) const
 Sets a link with GUID. More...
 
void SetView (const TDF_LabelSequence &theShapes, const TDF_LabelSequence &theGDTs, const TDF_LabelSequence &theClippingPlanes, const TDF_Label &theViewL) const
 Sets a link with GUID. More...
 
void SetView (const TDF_LabelSequence &theShapes, const TDF_LabelSequence &theGDTs, const TDF_Label &theViewL) const
 Sets a link with GUID. More...
 
void SetClippingPlanes (const TDF_LabelSequence &theClippingPlaneLabels, const TDF_Label &theViewL) const
 Set Clipping planes to given View. More...
 
void RemoveView (const TDF_Label &theViewL)
 Remove View. More...
 
Standard_Boolean GetViewLabelsForShape (const TDF_Label &theShapeL, TDF_LabelSequence &theViews) const
 Returns all View labels defined for label ShapeL. More...
 
Standard_Boolean GetViewLabelsForGDT (const TDF_Label &theGDTL, TDF_LabelSequence &theViews) const
 Returns all View labels defined for label GDTL. More...
 
Standard_Boolean GetViewLabelsForClippingPlane (const TDF_Label &theClippingPlaneL, TDF_LabelSequence &theViews) const
 Returns all View labels defined for label ClippingPlaneL. More...
 
Standard_Boolean GetViewLabelsForNote (const TDF_Label &theNoteL, TDF_LabelSequence &theViews) const
 Returns all View labels defined for label NoteL. More...
 
Standard_Boolean GetViewLabelsForAnnotation (const TDF_Label &theAnnotationL, TDF_LabelSequence &theViews) const
 Returns all View labels defined for label AnnotationL. More...
 
TDF_Label AddView ()
 Adds a view definition to a View table and returns its label. More...
 
Standard_Boolean GetRefShapeLabel (const TDF_Label &theViewL, TDF_LabelSequence &theShapeLabels) const
 Returns shape labels defined for label theViewL Returns False if the theViewL is not in View table. More...
 
Standard_Boolean GetRefGDTLabel (const TDF_Label &theViewL, TDF_LabelSequence &theGDTLabels) const
 Returns GDT labels defined for label theViewL Returns False if the theViewL is not in View table. More...
 
Standard_Boolean GetRefClippingPlaneLabel (const TDF_Label &theViewL, TDF_LabelSequence &theClippingPlaneLabels) const
 Returns ClippingPlane labels defined for label theViewL Returns False if the theViewL is not in View table. More...
 
Standard_Boolean GetRefNoteLabel (const TDF_Label &theViewL, TDF_LabelSequence &theNoteLabels) const
 Returns Notes labels defined for label theViewL Returns False if the theViewL is not in View table. More...
 
Standard_Boolean GetRefAnnotationLabel (const TDF_Label &theViewL, TDF_LabelSequence &theAnnotationLabels) const
 Returns Annotation labels defined for label theViewL Returns False if the theViewL is not in View table. More...
 
Standard_Boolean IsLocked (const TDF_Label &theViewL) const
 Returns true if the given View is marked as locked. More...
 
void Lock (const TDF_Label &theViewL) const
 Mark the given View as locked. More...
 
void Unlock (const TDF_Label &theViewL) const
 Unlock the given View. More...
 
const Standard_GUIDID () const override
 Returns the ID of the attribute. More...
 
- Public Member Functions inherited from TDataStd_GenericEmpty
void Restore (const Handle< TDF_Attribute > &) override
 Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
void Paste (const Handle< TDF_Attribute > &, const Handle< TDF_RelocationTable > &) const override
 This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from TDF_Attribute
virtual void SetID (const Standard_GUID &)
 Sets specific ID of the attribute (supports several attributes of one type at the same label feature). More...
 
virtual void SetID ()
 Sets default ID defined in nested class (to be used for attributes having User ID feature). More...
 
const TDF_Label Label () const
 Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline. More...
 
Standard_Integer Transaction () const
 Returns the transaction index in which the attribute has been created or modified. More...
 
Standard_Integer UntilTransaction () const
 Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index. More...
 
Standard_Boolean IsValid () const
 Returns true if the attribute is valid; i.e. not a backuped or removed one. More...
 
Standard_Boolean IsNew () const
 Returns true if the attribute has no backup. More...
 
Standard_Boolean IsForgotten () const
 Returns true if the attribute forgotten status is set. More...
 
Standard_Boolean IsAttribute (const Standard_GUID &anID) const
 Returns true if it exists an associated attribute of <me> with <anID> as ID. More...
 
Standard_Boolean FindAttribute (const Standard_GUID &anID, Handle< TDF_Attribute > &anAttribute) const
 Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method. More...
 
template<class T >
Standard_Boolean FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const
 Safe variant for arbitrary type of argument. More...
 
void AddAttribute (const Handle< TDF_Attribute > &other) const
 Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>. More...
 
Standard_Boolean ForgetAttribute (const Standard_GUID &aguid) const
 Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True. More...
 
void ForgetAllAttributes (const Standard_Boolean clearChildren=Standard_True) const
 Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call. More...
 
virtual void AfterAddition ()
 Something to do after adding an Attribute to a label. More...
 
virtual void BeforeRemoval ()
 Something to do before removing an Attribute from a label. More...
 
virtual void BeforeForget ()
 Something to do before forgetting an Attribute to a label. More...
 
virtual void AfterResume ()
 Something to do after resuming an Attribute from a label. More...
 
virtual Standard_Boolean AfterRetrieval (const Standard_Boolean forceIt=Standard_False)
 Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. More...
 
virtual Standard_Boolean BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
 Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. More...
 
virtual Standard_Boolean AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
 Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true. More...
 
virtual void BeforeCommitTransaction ()
 A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method. More...
 
void Backup ()
 Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid". More...
 
Standard_Boolean IsBackuped () const
 Returns true if the attribute backup status is set. This status is set/unset by the Backup() method. More...
 
virtual Handle< TDF_AttributeBackupCopy () const
 Copies the attribute contents into a new other attribute. It is used by Backup(). More...
 
virtual Handle< TDF_DeltaOnAdditionDeltaOnAddition () const
 Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta). More...
 
virtual Handle< TDF_DeltaOnForgetDeltaOnForget () const
 Makes an AttributeDelta because <me> has been forgotten. More...
 
virtual Handle< TDF_DeltaOnResumeDeltaOnResume () const
 Makes an AttributeDelta because <me> has been resumed. More...
 
virtual Handle< TDF_DeltaOnModificationDeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const
 Makes a DeltaOnModification between <me> and <anOldAttribute. More...
 
virtual void DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
 Applies a DeltaOnModification to <me>. More...
 
virtual Handle< TDF_DeltaOnRemovalDeltaOnRemoval () const
 Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. More...
 
virtual Handle< TDF_AttributeNewEmpty () const =0
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
virtual void References (const Handle< TDF_DataSet > &aDataSet) const
 Adds the first level referenced attributes and labels to <aDataSet>. More...
 
virtual Standard_OStreamDump (Standard_OStream &anOS) const
 Dumps the minimum information about <me> on <aStream>. More...
 
Standard_OStreamoperator<< (Standard_OStream &anOS) const
 
virtual void ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const
 Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field. More...
 
void Forget (const Standard_Integer aTransaction)
 Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid". 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...
 

Static Public Member Functions

static Handle< XCAFDoc_ViewToolSet (const TDF_Label &L)
 Creates (if not exist) ViewTool. More...
 
static const Standard_GUIDGetID ()
 
- 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Member Functions inherited from TDF_Attribute
 TDF_Attribute ()
 Initializes fields. More...
 

Detailed Description

Provides tools to store and retrieve Views in and from TDocStd_Document Each View contains parts XCAFDoc_View attribute with all information about camera and view window. Also each view contain information of displayed shapes and GDTs as sets of shape and GDT labels.

Constructor & Destructor Documentation

◆ XCAFDoc_ViewTool()

XCAFDoc_ViewTool::XCAFDoc_ViewTool ( )

Member Function Documentation

◆ AddView()

TDF_Label XCAFDoc_ViewTool::AddView ( )

Adds a view definition to a View table and returns its label.

◆ BaseLabel()

TDF_Label XCAFDoc_ViewTool::BaseLabel ( ) const

Returns the label under which Views are stored.

◆ GetID()

static const Standard_GUID& XCAFDoc_ViewTool::GetID ( )
static

◆ GetRefAnnotationLabel()

Standard_Boolean XCAFDoc_ViewTool::GetRefAnnotationLabel ( const TDF_Label theViewL,
TDF_LabelSequence theAnnotationLabels 
) const

Returns Annotation labels defined for label theViewL Returns False if the theViewL is not in View table.

◆ GetRefClippingPlaneLabel()

Standard_Boolean XCAFDoc_ViewTool::GetRefClippingPlaneLabel ( const TDF_Label theViewL,
TDF_LabelSequence theClippingPlaneLabels 
) const

Returns ClippingPlane labels defined for label theViewL Returns False if the theViewL is not in View table.

◆ GetRefGDTLabel()

Standard_Boolean XCAFDoc_ViewTool::GetRefGDTLabel ( const TDF_Label theViewL,
TDF_LabelSequence theGDTLabels 
) const

Returns GDT labels defined for label theViewL Returns False if the theViewL is not in View table.

◆ GetRefNoteLabel()

Standard_Boolean XCAFDoc_ViewTool::GetRefNoteLabel ( const TDF_Label theViewL,
TDF_LabelSequence theNoteLabels 
) const

Returns Notes labels defined for label theViewL Returns False if the theViewL is not in View table.

◆ GetRefShapeLabel()

Standard_Boolean XCAFDoc_ViewTool::GetRefShapeLabel ( const TDF_Label theViewL,
TDF_LabelSequence theShapeLabels 
) const

Returns shape labels defined for label theViewL Returns False if the theViewL is not in View table.

◆ GetViewLabels()

void XCAFDoc_ViewTool::GetViewLabels ( TDF_LabelSequence theLabels) const

Returns a sequence of View labels currently stored in the View table.

◆ GetViewLabelsForAnnotation()

Standard_Boolean XCAFDoc_ViewTool::GetViewLabelsForAnnotation ( const TDF_Label theAnnotationL,
TDF_LabelSequence theViews 
) const

Returns all View labels defined for label AnnotationL.

◆ GetViewLabelsForClippingPlane()

Standard_Boolean XCAFDoc_ViewTool::GetViewLabelsForClippingPlane ( const TDF_Label theClippingPlaneL,
TDF_LabelSequence theViews 
) const

Returns all View labels defined for label ClippingPlaneL.

◆ GetViewLabelsForGDT()

Standard_Boolean XCAFDoc_ViewTool::GetViewLabelsForGDT ( const TDF_Label theGDTL,
TDF_LabelSequence theViews 
) const

Returns all View labels defined for label GDTL.

◆ GetViewLabelsForNote()

Standard_Boolean XCAFDoc_ViewTool::GetViewLabelsForNote ( const TDF_Label theNoteL,
TDF_LabelSequence theViews 
) const

Returns all View labels defined for label NoteL.

◆ GetViewLabelsForShape()

Standard_Boolean XCAFDoc_ViewTool::GetViewLabelsForShape ( const TDF_Label theShapeL,
TDF_LabelSequence theViews 
) const

Returns all View labels defined for label ShapeL.

◆ ID()

const Standard_GUID& XCAFDoc_ViewTool::ID ( ) const
overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ IsLocked()

Standard_Boolean XCAFDoc_ViewTool::IsLocked ( const TDF_Label theViewL) const

Returns true if the given View is marked as locked.

◆ IsView()

Standard_Boolean XCAFDoc_ViewTool::IsView ( const TDF_Label theLabel) const

Returns True if label belongs to a View table and is a View definition.

◆ Lock()

void XCAFDoc_ViewTool::Lock ( const TDF_Label theViewL) const

Mark the given View as locked.

◆ RemoveView()

void XCAFDoc_ViewTool::RemoveView ( const TDF_Label theViewL)

Remove View.

◆ Set()

static Handle< XCAFDoc_ViewTool > XCAFDoc_ViewTool::Set ( const TDF_Label L)
static

Creates (if not exist) ViewTool.

◆ SetClippingPlanes()

void XCAFDoc_ViewTool::SetClippingPlanes ( const TDF_LabelSequence theClippingPlaneLabels,
const TDF_Label theViewL 
) const

Set Clipping planes to given View.

◆ SetView() [1/3]

void XCAFDoc_ViewTool::SetView ( const TDF_LabelSequence theShapes,
const TDF_LabelSequence theGDTs,
const TDF_Label theViewL 
) const

Sets a link with GUID.

◆ SetView() [2/3]

void XCAFDoc_ViewTool::SetView ( const TDF_LabelSequence theShapes,
const TDF_LabelSequence theGDTs,
const TDF_LabelSequence theClippingPlanes,
const TDF_Label theViewL 
) const

Sets a link with GUID.

◆ SetView() [3/3]

void XCAFDoc_ViewTool::SetView ( const TDF_LabelSequence theShapes,
const TDF_LabelSequence theGDTs,
const TDF_LabelSequence theClippingPlanes,
const TDF_LabelSequence theNotes,
const TDF_LabelSequence theAnnotations,
const TDF_Label theViewL 
) const

Sets a link with GUID.

◆ Unlock()

void XCAFDoc_ViewTool::Unlock ( const TDF_Label theViewL) const

Unlock the given View.


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