Open CASCADE Technology  7.7.0
Data Structures | Public Member Functions | Data Fields

RWGltf_ConfigurationNode Class Reference

The purpose of this class is to configure the transfer process for glTF format Stores the necessary settings for RWGltf_Provider. Configures and creates special provider to transfer glTF files. More...

#include <RWGltf_ConfigurationNode.hxx>

Inheritance diagram for RWGltf_ConfigurationNode:
Inheritance graph
[legend]

Data Structures

struct  RWGltf_InternalSection
 

Public Member Functions

 RWGltf_ConfigurationNode ()
 Initializes all field by default. More...
 
 RWGltf_ConfigurationNode (const Handle< RWGltf_ConfigurationNode > &theNode)
 Copies values of all fields. More...
 
virtual bool Load (const Handle< DE_ConfigurationContext > &theResource) override
 Updates values according the resource. More...
 
virtual TCollection_AsciiString Save () const override
 Writes configuration to the string. More...
 
virtual Handle< DE_ConfigurationNodeCopy () const override
 Copies values of all fields. More...
 
virtual Handle< DE_ProviderBuildProvider () override
 Creates new provider for the own format. More...
 
virtual bool IsImportSupported () const override
 Checks the import supporting. More...
 
virtual bool IsExportSupported () const override
 Checks the export supporting. 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...
 
virtual TColStd_ListOfAsciiString GetExtensions () const override
 Gets list of supported file extensions. More...
 
- Public Member Functions inherited from DE_ConfigurationNode
 DE_ConfigurationNode ()
 Initializes all field by default. More...
 
 DE_ConfigurationNode (const Handle< DE_ConfigurationNode > &theConfigurationNode)
 Copies values of all fields. More...
 
virtual bool Load (const TCollection_AsciiString &theResourcePath="")
 Updates values according the resource file. More...
 
bool Save (const TCollection_AsciiString &theResourcePath) const
 Writes configuration to the resource file. More...
 
virtual bool UpdateLoad ()
 Update loading status. Checking for the license. More...
 
virtual bool CheckExtension (const TCollection_AsciiString &theExtension) const
 Checks the file extension to verify a format. More...
 
virtual bool CheckContent (const Handle< NCollection_Buffer > &theBuffer) const
 Checks the file content to verify a format. More...
 
Standard_Boolean IsEnabled () const
 Gets the provider loading status. More...
 
void SetEnabled (const Standard_Boolean theIsLoaded)
 Sets the provider loading status. 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...
 

Data Fields

struct RWGltf_ConfigurationNode::RWGltf_InternalSection InternalParameters
 
- Data Fields inherited from DE_ConfigurationNode
struct DE_ConfigurationNode::DE_SectionGlobal GlobalParameters
 

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 purpose of this class is to configure the transfer process for glTF format Stores the necessary settings for RWGltf_Provider. Configures and creates special provider to transfer glTF files.

Nodes grouped by Vendor name and Format type. The Vendor name is "OCC" The Format type is "GLTF" The supported CAD extensions are ".gltf", ".glb" The import process is supported. The export process is supported.

Constructor & Destructor Documentation

◆ RWGltf_ConfigurationNode() [1/2]

RWGltf_ConfigurationNode::RWGltf_ConfigurationNode ( )

Initializes all field by default.

◆ RWGltf_ConfigurationNode() [2/2]

RWGltf_ConfigurationNode::RWGltf_ConfigurationNode ( const Handle< RWGltf_ConfigurationNode > &  theNode)

Copies values of all fields.

Parameters
[in]theNodeobject to copy

Member Function Documentation

◆ BuildProvider()

virtual Handle< DE_Provider > RWGltf_ConfigurationNode::BuildProvider ( )
overridevirtual

Creates new provider for the own format.

Returns
new created provider

Implements DE_ConfigurationNode.

◆ Copy()

virtual Handle< DE_ConfigurationNode > RWGltf_ConfigurationNode::Copy ( ) const
overridevirtual

Copies values of all fields.

Returns
new object with the same field values

Implements DE_ConfigurationNode.

◆ GetExtensions()

virtual TColStd_ListOfAsciiString RWGltf_ConfigurationNode::GetExtensions ( ) const
overridevirtual

Gets list of supported file extensions.

Returns
list of extensions

Implements DE_ConfigurationNode.

◆ GetFormat()

virtual TCollection_AsciiString RWGltf_ConfigurationNode::GetFormat ( ) const
overridevirtual

Gets CAD format name of associated provider.

Returns
provider CAD format

Implements DE_ConfigurationNode.

◆ GetVendor()

virtual TCollection_AsciiString RWGltf_ConfigurationNode::GetVendor ( ) const
overridevirtual

Gets provider's vendor name of associated provider.

Returns
provider's vendor name

Implements DE_ConfigurationNode.

◆ IsExportSupported()

virtual bool RWGltf_ConfigurationNode::IsExportSupported ( ) const
overridevirtual

Checks the export supporting.

Returns
true if export is supported

Reimplemented from DE_ConfigurationNode.

◆ IsImportSupported()

virtual bool RWGltf_ConfigurationNode::IsImportSupported ( ) const
overridevirtual

Checks the import supporting.

Returns
true if import is supported

Reimplemented from DE_ConfigurationNode.

◆ Load()

virtual bool RWGltf_ConfigurationNode::Load ( const Handle< DE_ConfigurationContext > &  theResource)
overridevirtual

Updates values according the resource.

Parameters
[in]theResourceinput resource to use
Returns
true if theResource loading has ended correctly

Implements DE_ConfigurationNode.

◆ Save()

virtual TCollection_AsciiString RWGltf_ConfigurationNode::Save ( ) const
overridevirtual

Writes configuration to the string.

Returns
result resource string

Implements DE_ConfigurationNode.

Field Documentation

◆ InternalParameters

struct RWGltf_ConfigurationNode::RWGltf_InternalSection RWGltf_ConfigurationNode::InternalParameters

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