Open CASCADE Technology  7.7.0.dev
Public Member Functions

RWPly_Provider Class Reference

The class to transfer PLY files. Writes any PLY files from OCCT. Each operation needs configuration node. More...

#include <RWPly_Provider.hxx>

Inheritance diagram for RWPly_Provider:
Inheritance graph
[legend]

Public Member Functions

 RWPly_Provider ()
 Default constructor Configure translation process with global configuration. More...
 
 RWPly_Provider (const Handle< DE_ConfigurationNode > &theNode)
 Configure translation process. More...
 
virtual bool Write (const TCollection_AsciiString &thePath, const Handle< TDocStd_Document > &theDocument, Handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 Writes a CAD file, according internal configuration. More...
 
virtual bool Write (const TCollection_AsciiString &thePath, const Handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 Writes a CAD file, according internal configuration. More...
 
virtual bool Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, Handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 Writes a CAD file, according internal configuration. More...
 
virtual bool Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 Writes a CAD file, according internal configuration. More...
 
virtual TCollection_AsciiString GetFormat () const override
 Gets CAD format name of associated provider. More...
 
virtual TCollection_AsciiString GetVendor () const override
 Gets provider's vendor name of associated provider. More...
 
- Public Member Functions inherited from DE_Provider
 DE_Provider ()
 Default constructor Configure translation process with global configuration. More...
 
 DE_Provider (const Handle< DE_ConfigurationNode > &theNode)
 Configure translation process. More...
 
virtual Standard_Boolean Read (const TCollection_AsciiString &thePath, const Handle< TDocStd_Document > &theDocument, Handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads a CAD file, according internal configuration. More...
 
virtual Standard_Boolean Read (const TCollection_AsciiString &thePath, const Handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads a CAD file, according internal configuration. More...
 
virtual Standard_Boolean Read (const TCollection_AsciiString &thePath, TopoDS_Shape &theShape, Handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads a CAD file, according internal configuration. More...
 
virtual Standard_Boolean Read (const TCollection_AsciiString &thePath, TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads a CAD file, according internal configuration. More...
 
Handle< DE_ConfigurationNodeGetNode () const
 Gets internal configuration node. More...
 
void SetNode (const Handle< DE_ConfigurationNode > &theNode)
 Sets internal configuration node. 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...
 

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

The class to transfer PLY files. Writes any PLY files from OCCT. Each operation needs configuration node.

Providers grouped by Vendor name and Format type. The Vendor name is "OCC" The Format type is "PLY" The import process isn't supported. The export process is supported.

Constructor & Destructor Documentation

◆ RWPly_Provider() [1/2]

RWPly_Provider::RWPly_Provider ( )

Default constructor Configure translation process with global configuration.

◆ RWPly_Provider() [2/2]

RWPly_Provider::RWPly_Provider ( const Handle< DE_ConfigurationNode > &  theNode)

Configure translation process.

Parameters
[in]theNodeobject to copy

Member Function Documentation

◆ GetFormat()

virtual TCollection_AsciiString RWPly_Provider::GetFormat ( ) const
overridevirtual

Gets CAD format name of associated provider.

Returns
provider CAD format

Implements DE_Provider.

◆ GetVendor()

virtual TCollection_AsciiString RWPly_Provider::GetVendor ( ) const
overridevirtual

Gets provider's vendor name of associated provider.

Returns
provider's vendor name

Implements DE_Provider.

◆ Write() [1/4]

virtual bool RWPly_Provider::Write ( const TCollection_AsciiString thePath,
const Handle< TDocStd_Document > &  theDocument,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

Writes a CAD file, according internal configuration.

Parameters
[in]thePathpath to the export CAD file
[out]theDocumentdocument to export
theProgress[in]progress indicator
Returns
true if Write operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [2/4]

virtual bool RWPly_Provider::Write ( const TCollection_AsciiString thePath,
const Handle< TDocStd_Document > &  theDocument,
Handle< XSControl_WorkSession > &  theWS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

Writes a CAD file, according internal configuration.

Parameters
[in]thePathpath to the export CAD file
[out]theDocumentdocument to export
[in]theWScurrent work session
theProgress[in]progress indicator
Returns
true if Write operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [3/4]

virtual bool RWPly_Provider::Write ( const TCollection_AsciiString thePath,
const TopoDS_Shape theShape,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

Writes a CAD file, according internal configuration.

Parameters
[in]thePathpath to the export CAD file
[out]theShapeshape to export
theProgress[in]progress indicator
Returns
true if Write operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [4/4]

virtual bool RWPly_Provider::Write ( const TCollection_AsciiString thePath,
const TopoDS_Shape theShape,
Handle< XSControl_WorkSession > &  theWS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

Writes a CAD file, according internal configuration.

Parameters
[in]thePathpath to the export CAD file
[out]theShapeshape to export
[in]theWScurrent work session
theProgress[in]progress indicator
Returns
true if Write operation has ended correctly

Reimplemented from DE_Provider.


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