Open CASCADE Technology  7.4.0
Public Member Functions | Static Public Member Functions

TDataXtd_Triangulation Class Reference

An Ocaf attribute containing a mesh (Poly_Triangulation). It duplicates all methods from Poly_Triangulation. It is highly recommended to modify the mesh through the methods of this attribute, but not directly via the underlying Poly_Triangulation object. In this case Undo/Redo will work fine and robust. More...

#include <TDataXtd_Triangulation.hxx>

Inheritance diagram for TDataXtd_Triangulation:
Inheritance graph
[legend]

Public Member Functions

 TDataXtd_Triangulation ()
 Object methods. More...
 
void Set (const Handle< Poly_Triangulation > &theTriangulation)
 Sets the triangulation. More...
 
const Handle< Poly_Triangulation > & Get () const
 Returns the underlying triangulation. More...
 
Standard_Real Deflection () const
 Poly_Triangulation methods. More...
 
void Deflection (const Standard_Real theDeflection)
 Sets the deflection of this triangulation to theDeflection. See more on deflection in Polygon2D. More...
 
void RemoveUVNodes ()
 Deallocates the UV nodes. More...
 
Standard_Integer NbNodes () const
 
Standard_Integer NbTriangles () const
 
Standard_Boolean HasUVNodes () const
 
const gp_PntNode (const Standard_Integer theIndex) const
 
void SetNode (const Standard_Integer theIndex, const gp_Pnt &theNode)
 The method differs from Poly_Triangulation! Sets a node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes. More...
 
const gp_Pnt2dUVNode (const Standard_Integer theIndex) const
 
void SetUVNode (const Standard_Integer theIndex, const gp_Pnt2d &theUVNode)
 The method differs from Poly_Triangulation! Sets a UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes. More...
 
const Poly_TriangleTriangle (const Standard_Integer theIndex) const
 
void SetTriangle (const Standard_Integer theIndex, const Poly_Triangle &theTriangle)
 The method differs from Poly_Triangulation! Sets a triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles. More...
 
void SetNormals (const Handle< TShort_HArray1OfShortReal > &theNormals)
 Sets the table of node normals. Raises exception if length of theNormals != 3 * NbNodes. More...
 
void SetNormal (const Standard_Integer theIndex, const gp_Dir &theNormal)
 Changes normal at the given index. Raises Standard_OutOfRange exception. More...
 
Standard_Boolean HasNormals () const
 Returns Standard_True if nodal normals are defined. More...
 
const gp_Dir Normal (const Standard_Integer theIndex) const
 
const Standard_GUIDID () const override
 Inherited attribute methods. More...
 
void Restore (const Handle< TDF_Attribute > &theAttribute) override
 Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction. More...
 
Handle< TDF_AttributeNewEmpty () const override
 Returns an new empty attribute from the good end type. It is used by the copy algorithm. More...
 
void Paste (const Handle< TDF_Attribute > &Into, const Handle< TDF_RelocationTable > &RT) 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 Standard_OStreamDump (Standard_OStream &anOS) const override
 Dumps the minimum information about <me> on <aStream>. 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 carefull 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 mecanisms. Be carefull 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 void References (const Handle< TDF_DataSet > &aDataSet) const
 Adds the first level referenced attributes and labels to <aDataSet>. 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 const Standard_GUIDGetID ()
 Static methods. More...
 
static Handle< TDataXtd_TriangulationSet (const TDF_Label &theLabel)
 Finds or creates a triangulation attribute. More...
 
static Handle< TDataXtd_TriangulationSet (const TDF_Label &theLabel, const Handle< Poly_Triangulation > &theTriangulation)
 Finds or creates a triangulation attribute. Initializes the attribute by a Poly_Triangulation 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...
 

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

An Ocaf attribute containing a mesh (Poly_Triangulation). It duplicates all methods from Poly_Triangulation. It is highly recommended to modify the mesh through the methods of this attribute, but not directly via the underlying Poly_Triangulation object. In this case Undo/Redo will work fine and robust.

Constructor & Destructor Documentation

◆ TDataXtd_Triangulation()

TDataXtd_Triangulation::TDataXtd_Triangulation ( )

Object methods.

A constructor. Don't use it directly, use please the static method Set(), which returns the attribute attached to a label.

Member Function Documentation

◆ Deflection() [1/2]

Standard_Real TDataXtd_Triangulation::Deflection ( ) const

Poly_Triangulation methods.

The methods are "covered" by this attribute to prevent direct modification of the mesh. There is no performance problem to call Poly_Triangulation method through this attribute. The most of the methods are considered as "inline" by the compiler in release mode. Returns the deflection of this triangulation.

◆ Deflection() [2/2]

void TDataXtd_Triangulation::Deflection ( const Standard_Real  theDeflection)

Sets the deflection of this triangulation to theDeflection. See more on deflection in Polygon2D.

◆ Dump()

virtual Standard_OStream& TDataXtd_Triangulation::Dump ( Standard_OStream anOS) const
overridevirtual

Dumps the minimum information about <me> on <aStream>.

Reimplemented from TDF_Attribute.

◆ Get()

const Handle< Poly_Triangulation >& TDataXtd_Triangulation::Get ( ) const

Returns the underlying triangulation.

◆ GetID()

static const Standard_GUID& TDataXtd_Triangulation::GetID ( )
static

Static methods.

Returns the ID of the triangulation attribute.

◆ HasNormals()

Standard_Boolean TDataXtd_Triangulation::HasNormals ( ) const

Returns Standard_True if nodal normals are defined.

◆ HasUVNodes()

Standard_Boolean TDataXtd_Triangulation::HasUVNodes ( ) const
Returns
Standard_True if 2D nodes are associated with 3D nodes for this triangulation.

◆ ID()

const Standard_GUID& TDataXtd_Triangulation::ID ( ) const
overridevirtual

Inherited attribute methods.

Implements TDF_Attribute.

◆ NbNodes()

Standard_Integer TDataXtd_Triangulation::NbNodes ( ) const
Returns
the number of nodes for this triangulation.

◆ NbTriangles()

Standard_Integer TDataXtd_Triangulation::NbTriangles ( ) const
Returns
the number of triangles for this triangulation.

◆ NewEmpty()

Handle< TDF_Attribute > TDataXtd_Triangulation::NewEmpty ( ) const
overridevirtual

Returns an new empty attribute from the good end type. It is used by the copy algorithm.

Implements TDF_Attribute.

◆ Node()

const gp_Pnt& TDataXtd_Triangulation::Node ( const Standard_Integer  theIndex) const
Returns
node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ Normal()

const gp_Dir TDataXtd_Triangulation::Normal ( const Standard_Integer  theIndex) const
Returns
normal at the given index. Raises Standard_OutOfRange exception.

◆ Paste()

void TDataXtd_Triangulation::Paste ( const Handle< TDF_Attribute > &  intoAttribute,
const Handle< TDF_RelocationTable > &  aRelocationTable 
) const
overridevirtual

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

The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!

It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

Implements TDF_Attribute.

◆ RemoveUVNodes()

void TDataXtd_Triangulation::RemoveUVNodes ( )

Deallocates the UV nodes.

◆ Restore()

void TDataXtd_Triangulation::Restore ( const Handle< TDF_Attribute > &  anAttribute)
overridevirtual

Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

Implements TDF_Attribute.

◆ Set() [1/3]

static Handle< TDataXtd_Triangulation > TDataXtd_Triangulation::Set ( const TDF_Label theLabel)
static

Finds or creates a triangulation attribute.

◆ Set() [2/3]

static Handle< TDataXtd_Triangulation > TDataXtd_Triangulation::Set ( const TDF_Label theLabel,
const Handle< Poly_Triangulation > &  theTriangulation 
)
static

Finds or creates a triangulation attribute. Initializes the attribute by a Poly_Triangulation object.

◆ Set() [3/3]

void TDataXtd_Triangulation::Set ( const Handle< Poly_Triangulation > &  theTriangulation)

Sets the triangulation.

◆ SetNode()

void TDataXtd_Triangulation::SetNode ( const Standard_Integer  theIndex,
const gp_Pnt theNode 
)

The method differs from Poly_Triangulation! Sets a node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ SetNormal()

void TDataXtd_Triangulation::SetNormal ( const Standard_Integer  theIndex,
const gp_Dir theNormal 
)

Changes normal at the given index. Raises Standard_OutOfRange exception.

◆ SetNormals()

void TDataXtd_Triangulation::SetNormals ( const Handle< TShort_HArray1OfShortReal > &  theNormals)

Sets the table of node normals. Raises exception if length of theNormals != 3 * NbNodes.

◆ SetTriangle()

void TDataXtd_Triangulation::SetTriangle ( const Standard_Integer  theIndex,
const Poly_Triangle theTriangle 
)

The method differs from Poly_Triangulation! Sets a triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles.

◆ SetUVNode()

void TDataXtd_Triangulation::SetUVNode ( const Standard_Integer  theIndex,
const gp_Pnt2d theUVNode 
)

The method differs from Poly_Triangulation! Sets a UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ Triangle()

const Poly_Triangle& TDataXtd_Triangulation::Triangle ( const Standard_Integer  theIndex) const
Returns
triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles.

◆ UVNode()

const gp_Pnt2d& TDataXtd_Triangulation::UVNode ( const Standard_Integer  theIndex) const
Returns
UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

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