Mesh data wrapper for delayed triangulation loading. Class inherits Poly_Triangulation so that it can be put temporarily into TopoDS_Face within assembly structure. More...

#include <RWMesh_TriangulationSource.hxx>

Inheritance diagram for RWMesh_TriangulationSource:

[legend]

Public Member Functions
	RWMesh_TriangulationSource ()
	Constructor.

virtual	~RWMesh_TriangulationSource ()
	Destructor.

const Handle< RWMesh_TriangulationReader > &	Reader () const
	Returns reader allowing to read data from the buffer.

void	SetReader (const Handle< RWMesh_TriangulationReader > &theReader)
	Sets reader allowing to read data from the buffer.

Standard_Integer	DegeneratedTriNb () const
	Returns number of degenerated triangles collected during data reading. Used for debug statistic purpose.

Standard_Integer &	ChangeDegeneratedTriNb ()
	Gets access to number of degenerated triangles to collect them during data reading.

virtual Standard_Boolean	HasGeometry () const override
	Returns TRUE if triangulation has some geometry.

Standard_Integer	NbEdges () const
	Returns the number of edges for this triangulation.

Standard_Integer	Edge (Standard_Integer theIndex) const
	Returns edge at the given index.

void	SetEdge (Standard_Integer theIndex, Standard_Integer theEdge)
	Sets an edge.

Public Member Functions inherited from Poly_Triangulation
	Poly_Triangulation ()
	Constructs an empty triangulation.

	Poly_Triangulation (const Standard_Integer theNbNodes, const Standard_Integer theNbTriangles, const Standard_Boolean theHasUVNodes, const Standard_Boolean theHasNormals=false)
	Constructs a triangulation from a set of triangles. The triangulation is initialized without a triangle or a node, but capable of containing specified number of nodes and triangles.

	Poly_Triangulation (const TColgp_Array1OfPnt &Nodes, const Poly_Array1OfTriangle &Triangles)
	Constructs a triangulation from a set of triangles. The triangulation is initialized with 3D points from Nodes and triangles from Triangles.

	Poly_Triangulation (const TColgp_Array1OfPnt &Nodes, const TColgp_Array1OfPnt2d &UVNodes, const Poly_Array1OfTriangle &Triangles)
	Constructs a triangulation from a set of triangles. The triangulation is initialized with 3D points from Nodes, 2D points from UVNodes and triangles from Triangles, where coordinates of a 2D point from UVNodes are the (u, v) parameters of the corresponding 3D point from Nodes on the surface approximated by the constructed triangulation.

virtual	~Poly_Triangulation ()
	Destructor.

virtual Handle< Poly_Triangulation >	Copy () const
	Creates full copy of current triangulation.

	Poly_Triangulation (const Handle< Poly_Triangulation > &theTriangulation)
	Copy constructor for triangulation.

Standard_Real	Deflection () const
	Returns the deflection of this triangulation.

void	Deflection (const Standard_Real theDeflection)
	Sets the deflection of this triangulation to theDeflection. See more on deflection in Polygon2D.

const Handle< Poly_TriangulationParameters > &	Parameters () const
	Returns initial set of parameters used to generate this triangulation.

void	Parameters (const Handle< Poly_TriangulationParameters > &theParams)
	Updates initial set of parameters used to generate this triangulation.

virtual void	Clear ()
	Clears internal arrays of nodes and all attributes.

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

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

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

Standard_Boolean	HasNormals () const
	Returns Standard_True if nodal normals are defined.

gp_Pnt	Node (Standard_Integer theIndex) const
	Returns a node at the given index.

void	SetNode (Standard_Integer theIndex, const gp_Pnt &thePnt)
	Sets a node coordinates.

gp_Pnt2d	UVNode (Standard_Integer theIndex) const
	Returns UV-node at the given index.

void	SetUVNode (Standard_Integer theIndex, const gp_Pnt2d &thePnt)
	Sets an UV-node coordinates.

const Poly_Triangle &	Triangle (Standard_Integer theIndex) const
	Returns triangle at the given index.

void	SetTriangle (Standard_Integer theIndex, const Poly_Triangle &theTriangle)
	Sets a triangle.

gp_Dir	Normal (Standard_Integer theIndex) const
	Returns normal at the given index.

void	Normal (Standard_Integer theIndex, gp_Vec3f &theVec3) const
	Returns normal at the given index.

void	SetNormal (const Standard_Integer theIndex, const gp_Vec3f &theNormal)
	Changes normal at the given index.

void	SetNormal (const Standard_Integer theIndex, const gp_Dir &theNormal)
	Changes normal at the given index.

Poly_MeshPurpose	MeshPurpose () const
	Returns mesh purpose bits.

void	SetMeshPurpose (const Poly_MeshPurpose thePurpose)
	Sets mesh purpose bits.

const Bnd_Box &	CachedMinMax () const
	Returns cached min - max range of triangulation data, which is VOID by default (e.g, no cached information).

void	SetCachedMinMax (const Bnd_Box &theBox)
	Sets a cached min - max range of this triangulation. The bounding box should exactly match actual range of triangulation data without a gap or transformation, or otherwise undefined behavior will be observed. Passing a VOID range invalidates the cache.

Standard_Boolean	HasCachedMinMax () const
	Returns TRUE if there is some cached min - max range of this triangulation.

void	UpdateCachedMinMax ()
	Updates cached min - max range of this triangulation with bounding box of nodal data.

Standard_Boolean	MinMax (Bnd_Box &theBox, const gp_Trsf &theTrsf, const bool theIsAccurate=false) const
	Extends the passed box with bounding box of this triangulation. Uses cached min - max range when available and:

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

bool	IsDoublePrecision () const
	Returns TRUE if node positions are defined with double precision; TRUE by default.

void	SetDoublePrecision (bool theIsDouble)
	Set if node positions should be defined with double or single precision for 3D and UV nodes. Raises exception if data was already allocated.

void	ResizeNodes (Standard_Integer theNbNodes, Standard_Boolean theToCopyOld)
	Method resizing internal arrays of nodes (synchronously for all attributes).

void	ResizeTriangles (Standard_Integer theNbTriangles, Standard_Boolean theToCopyOld)
	Method resizing an internal array of triangles.

void	AddUVNodes ()
	If an array for UV coordinates is not allocated yet, do it now.

void	RemoveUVNodes ()
	Deallocates the UV nodes array.

void	AddNormals ()
	If an array for normals is not allocated yet, do it now.

void	RemoveNormals ()
	Deallocates the normals array.

void	ComputeNormals ()
	Compute smooth normals by averaging triangle normals.

Handle< TColgp_HArray1OfPnt >	MapNodeArray () const
	Returns the table of 3D points for read-only access or NULL if nodes array is undefined. Poly_Triangulation::Node() should be used instead when possible. Returned object should not be used after Poly_Triangulation destruction.

Handle< Poly_HArray1OfTriangle >	MapTriangleArray () const
	Returns the triangle array for read-only access or NULL if triangle array is undefined. Poly_Triangulation::Triangle() should be used instead when possible. Returned object should not be used after Poly_Triangulation destruction.

Handle< TColgp_HArray1OfPnt2d >	MapUVNodeArray () const
	Returns the table of 2D nodes for read-only access or NULL if UV nodes array is undefined. Poly_Triangulation::UVNode() should be used instead when possible. Returned object should not be used after Poly_Triangulation destruction.

Handle< TShort_HArray1OfShortReal >	MapNormalArray () const
	Returns the table of per-vertex normals for read-only access or NULL if normals array is undefined. Poly_Triangulation::Normal() should be used instead when possible. Returned object should not be used after Poly_Triangulation destruction.

Poly_Array1OfTriangle &	InternalTriangles ()
	Returns an internal array of triangles. Triangle()/SetTriangle() should be used instead in portable code.

Poly_ArrayOfNodes &	InternalNodes ()
	Returns an internal array of nodes. Node()/SetNode() should be used instead in portable code.

Poly_ArrayOfUVNodes &	InternalUVNodes ()
	Returns an internal array of UV nodes. UBNode()/SetUVNode() should be used instead in portable code.

NCollection_Array1< gp_Vec3f > &	InternalNormals ()
	Return an internal array of normals. Normal()/SetNormal() should be used instead in portable code.

void	SetNormals (const Handle< TShort_HArray1OfShortReal > &theNormals)

const Poly_Array1OfTriangle &	Triangles () const

Poly_Array1OfTriangle &	ChangeTriangles ()

Poly_Triangle &	ChangeTriangle (const Standard_Integer theIndex)

virtual Standard_Boolean	HasDeferredData () const
	Returns TRUE if there is some triangulation data that can be loaded using LoadDeferredData().

virtual Standard_Boolean	LoadDeferredData (const Handle< OSD_FileSystem > &theFileSystem=Handle< OSD_FileSystem >())
	Loads triangulation data into itself from some deferred storage using specified shared input file system.

virtual Handle< Poly_Triangulation >	DetachedLoadDeferredData (const Handle< OSD_FileSystem > &theFileSystem=Handle< OSD_FileSystem >()) const
	Loads triangulation data into new Poly_Triangulation object from some deferred storage using specified shared input file system.

virtual Standard_Boolean	UnloadDeferredData ()
	Releases triangulation data if it has connected deferred storage.

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.

late-load deferred data interface
Returns number of nodes for deferred loading. Note: this is estimated values defined in object header, which might be different from actually loaded values (due to broken header or extra mesh processing). Always check triangulation size of actually loaded data in code to avoid out-of-range issues.
Handle< RWMesh_TriangulationReader >	myReader
	Sets number of nodes for deferred loading.

NCollection_Array1< Standard_Integer >	myEdges
	Sets number of nodes for deferred loading.

Standard_Integer	myNbDefNodes
	Sets number of nodes for deferred loading.

Standard_Integer	myNbDefTriangles
	Sets number of nodes for deferred loading.

Standard_Integer	myStatisticOfDegeneratedTriNb
	Sets number of nodes for deferred loading.

virtual Standard_Integer	NbDeferredNodes () const override
	Sets number of nodes for deferred loading.

void	SetNbDeferredNodes (const Standard_Integer theNbNodes)
	Sets number of nodes for deferred loading.

virtual Standard_Integer	NbDeferredTriangles () const override
	Returns number of triangles for deferred loading. Note: this is estimated values defined in object header, which might be different from actually loaded values (due to broken header or extra mesh processing). Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

void	SetNbDeferredTriangles (const Standard_Integer theNbTris)
	Sets number of triangles for deferred loading.

NCollection_Array1< Standard_Integer > &	InternalEdges ()
	Returns an internal array of edges. Edge()/SetEdge() should be used instead in portable code.

void	ResizeEdges (Standard_Integer theNbEdges, Standard_Boolean theToCopyOld)
	Method resizing an internal array of triangles.

virtual Standard_Boolean	loadDeferredData (const Handle< OSD_FileSystem > &theFileSystem, const Handle< Poly_Triangulation > &theDestTriangulation) const override
	Loads triangulation data from deferred storage using specified shared input file system.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.

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.

virtual Handle< Poly_Triangulation >	createNewEntity () const
	Creates new triangulation object (can be inheritor of Poly_Triangulation).

void	unsetCachedMinMax ()
	Clears cached min - max range saved previously.

virtual Bnd_Box	computeBoundingBox (const gp_Trsf &theTrsf) const
	Calculates bounding box of nodal data.

Bnd_Box *	myCachedMinMax
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Standard_Real	myDeflection
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Poly_ArrayOfNodes	myNodes
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Poly_Array1OfTriangle	myTriangles
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Poly_ArrayOfUVNodes	myUVNodes
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

NCollection_Array1< gp_Vec3f >	myNormals
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Poly_MeshPurpose	myPurpose
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Handle< Poly_TriangulationParameters >	myParams
	Returns number of deferred triangles that can be loaded using LoadDeferredData(). Note: this is estimated values, which might be different from actually loaded values Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Detailed Description

Mesh data wrapper for delayed triangulation loading. Class inherits Poly_Triangulation so that it can be put temporarily into TopoDS_Face within assembly structure.

Constructor & Destructor Documentation

◆ RWMesh_TriangulationSource()

RWMesh_TriangulationSource::RWMesh_TriangulationSource ( )

Constructor.

◆ ~RWMesh_TriangulationSource()

virtual RWMesh_TriangulationSource::~RWMesh_TriangulationSource ( )

virtual

Destructor.

Member Function Documentation

◆ ChangeDegeneratedTriNb()

Standard_Integer & RWMesh_TriangulationSource::ChangeDegeneratedTriNb ( )

inline

Gets access to number of degenerated triangles to collect them during data reading.

◆ DegeneratedTriNb()

Standard_Integer RWMesh_TriangulationSource::DegeneratedTriNb ( ) const

inline

Returns number of degenerated triangles collected during data reading. Used for debug statistic purpose.

◆ Edge()

Standard_Integer RWMesh_TriangulationSource::Edge ( Standard_Integer theIndex ) const

inline

Returns edge at the given index.

Parameters

[in] theIndex edge index within [1, NbEdges()] range

Returns: edge node indices, with each node defined within [1, NbNodes()] range

◆ HasGeometry()

virtual Standard_Boolean RWMesh_TriangulationSource::HasGeometry ( ) const

inlineoverridevirtual

Returns TRUE if triangulation has some geometry.

Reimplemented from Poly_Triangulation.

◆ InternalEdges()

NCollection_Array1< Standard_Integer > & RWMesh_TriangulationSource::InternalEdges ( )

inline

Returns an internal array of edges. Edge()/SetEdge() should be used instead in portable code.

◆ loadDeferredData()

virtual Standard_Boolean RWMesh_TriangulationSource::loadDeferredData	(	const Handle< OSD_FileSystem > &	theFileSystem,
		const Handle< Poly_Triangulation > &	theDestTriangulation ) const

overrideprotectedvirtual

Loads triangulation data from deferred storage using specified shared input file system.

Reimplemented from Poly_Triangulation.

◆ NbDeferredNodes()

virtual Standard_Integer RWMesh_TriangulationSource::NbDeferredNodes ( ) const

inlineoverridevirtual

Sets number of nodes for deferred loading.

Reimplemented from Poly_Triangulation.

◆ NbDeferredTriangles()

virtual Standard_Integer RWMesh_TriangulationSource::NbDeferredTriangles ( ) const

inlineoverridevirtual

Returns number of triangles for deferred loading. Note: this is estimated values defined in object header, which might be different from actually loaded values (due to broken header or extra mesh processing). Always check triangulation size of actually loaded data in code to avoid out-of-range issues.

Reimplemented from Poly_Triangulation.

◆ NbEdges()

Standard_Integer RWMesh_TriangulationSource::NbEdges ( ) const

inline

Returns the number of edges for this triangulation.

◆ Reader()

const Handle< RWMesh_TriangulationReader > & RWMesh_TriangulationSource::Reader ( ) const

inline

Returns reader allowing to read data from the buffer.

◆ ResizeEdges()

void RWMesh_TriangulationSource::ResizeEdges	(	Standard_Integer	theNbEdges,
		Standard_Boolean	theToCopyOld )

Method resizing an internal array of triangles.

Parameters

[in]	theNbTriangles	new number of triangles
[in]	theToCopyOld	copy old triangles into the new array

◆ SetEdge()

void RWMesh_TriangulationSource::SetEdge	(	Standard_Integer	theIndex,
		Standard_Integer	theEdge )

inline

Sets an edge.

Parameters

[in]	theIndex	edge index within [1, NbEdges()] range
[in]	theEdge	edge node indices, with each node defined within [1, NbNodes()] range

◆ SetNbDeferredNodes()

void RWMesh_TriangulationSource::SetNbDeferredNodes ( const Standard_Integer theNbNodes )

inline

Sets number of nodes for deferred loading.

◆ SetNbDeferredTriangles()

void RWMesh_TriangulationSource::SetNbDeferredTriangles ( const Standard_Integer theNbTris )

inline

Sets number of triangles for deferred loading.

◆ SetReader()

void RWMesh_TriangulationSource::SetReader ( const Handle< RWMesh_TriangulationReader > & theReader )

inline

Sets reader allowing to read data from the buffer.

Field Documentation

◆ myEdges

NCollection_Array1<Standard_Integer> RWMesh_TriangulationSource::myEdges

protected

Sets number of nodes for deferred loading.

◆ myNbDefNodes

Standard_Integer RWMesh_TriangulationSource::myNbDefNodes

protected

Sets number of nodes for deferred loading.

◆ myNbDefTriangles

Standard_Integer RWMesh_TriangulationSource::myNbDefTriangles

protected

Sets number of nodes for deferred loading.

◆ myReader

Handle< RWMesh_TriangulationReader > RWMesh_TriangulationSource::myReader

protected

Sets number of nodes for deferred loading.

◆ myStatisticOfDegeneratedTriNb

Standard_Integer RWMesh_TriangulationSource::myStatisticOfDegeneratedTriNb

mutableprotected

Sets number of nodes for deferred loading.

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

RWMesh_TriangulationSource.hxx

Public Member Functions

late-load deferred data interface

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RWMesh_TriangulationSource()

◆ ~RWMesh_TriangulationSource()

Member Function Documentation

◆ ChangeDegeneratedTriNb()

◆ DegeneratedTriNb()

◆ Edge()

◆ HasGeometry()

◆ InternalEdges()

◆ loadDeferredData()

◆ NbDeferredNodes()

◆ NbDeferredTriangles()

◆ NbEdges()

◆ Reader()

◆ ResizeEdges()

◆ SetEdge()

◆ SetNbDeferredNodes()

◆ SetNbDeferredTriangles()

◆ SetReader()

Field Documentation

◆ myEdges

◆ myNbDefNodes

◆ myNbDefTriangles

◆ myReader

◆ myStatisticOfDegeneratedTriNb