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

#include <Vrml_ConfigurationNode.hxx>

Inheritance diagram for Vrml_ConfigurationNode:

[legend]

Data Structures
struct	Vrml_InternalSection

Public Types
enum	WriteMode_WriterVersion { WriteMode_WriterVersion_1 = 1 , WriteMode_WriterVersion_2 }

enum	WriteMode_RepresentationType { WriteMode_RepresentationType_Shaded = 0 , WriteMode_RepresentationType_Wireframe , WriteMode_RepresentationType_Both }

Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Public Member Functions
	Vrml_ConfigurationNode ()
	Initializes all field by default.

	Vrml_ConfigurationNode (const Handle< Vrml_ConfigurationNode > &theNode)
	Copies values of all fields.

virtual bool	Load (const Handle< DE_ConfigurationContext > &theResource) override
	Updates values according the resource.

virtual TCollection_AsciiString	Save () const override
	Writes configuration to the string.

virtual Handle< DE_ConfigurationNode >	Copy () const override
	Copies values of all fields.

virtual Handle< DE_Provider >	BuildProvider () override
	Creates new provider for the own format.

virtual bool	IsImportSupported () const override
	Checks the import supporting.

virtual bool	IsExportSupported () const override
	Checks the export supporting.

virtual TCollection_AsciiString	GetFormat () const override
	Gets CAD format name of associated provider.

virtual TCollection_AsciiString	GetVendor () const override
	Gets provider's vendor name of associated provider.

virtual TColStd_ListOfAsciiString	GetExtensions () const override
	Gets list of supported file extensions.

Public Member Functions inherited from DE_ConfigurationNode
	DE_ConfigurationNode ()
	Initializes all field by default.

	DE_ConfigurationNode (const Handle< DE_ConfigurationNode > &theConfigurationNode)
	Copies values of all fields.

virtual bool	Load (const TCollection_AsciiString &theResourcePath="")
	Updates values according the resource file.

bool	Save (const TCollection_AsciiString &theResourcePath) const
	Writes configuration to the resource file.

virtual bool	UpdateLoad (const Standard_Boolean theToImport, const Standard_Boolean theToKeep)
	Update loading status. Checking for the ability to read and write.

virtual bool	CheckExtension (const TCollection_AsciiString &theExtension) const
	Checks the file extension to verify a format.

virtual bool	CheckContent (const Handle< NCollection_Buffer > &theBuffer) const
	Checks the file content to verify a format.

Standard_Boolean	IsEnabled () const
	Gets the provider loading status.

void	SetEnabled (const Standard_Boolean theIsLoaded)
	Sets the provider loading status.

virtual void	CustomActivation (const TColStd_ListOfAsciiString &)
	Custom function to activate commercial DE component. The input is special sequence of values that described in specific component documentation. Order is important. Each component can have own way of activation.

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.

Data Fields
struct Vrml_ConfigurationNode::Vrml_InternalSection	InternalParameters

Data Fields inherited from DE_ConfigurationNode
struct DE_ConfigurationNode::DE_SectionGlobal	GlobalParameters

Additional Inherited Members
Static Public Member Functions inherited from Standard_Transient
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.

Detailed Description

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

Nodes grouped by Vendor name and Format type. The Vendor name is "OCC" The Format type is "VRML" The supported CAD extensions are ".vrml", ".wrl" The import process is supported. The export process is supported.

Member Enumeration Documentation

◆ WriteMode_RepresentationType

enum Vrml_ConfigurationNode::WriteMode_RepresentationType

Enumerator
WriteMode_RepresentationType_Shaded
WriteMode_RepresentationType_Wireframe
WriteMode_RepresentationType_Both

◆ WriteMode_WriterVersion

enum Vrml_ConfigurationNode::WriteMode_WriterVersion

Enumerator
WriteMode_WriterVersion_1
WriteMode_WriterVersion_2

Constructor & Destructor Documentation

◆ Vrml_ConfigurationNode() [1/2]

Vrml_ConfigurationNode::Vrml_ConfigurationNode ( )

Initializes all field by default.

◆ Vrml_ConfigurationNode() [2/2]

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

Copies values of all fields.

Parameters

[in] theNode object to copy

Member Function Documentation

◆ BuildProvider()

virtual Handle< DE_Provider > Vrml_ConfigurationNode::BuildProvider ( )

overridevirtual

Creates new provider for the own format.

Returns: new created provider

Implements DE_ConfigurationNode.

◆ Copy()

virtual Handle< DE_ConfigurationNode > Vrml_ConfigurationNode::Copy ( ) const

overridevirtual

Copies values of all fields.

Returns: new object with the same field values

Implements DE_ConfigurationNode.

◆ GetExtensions()

virtual TColStd_ListOfAsciiString Vrml_ConfigurationNode::GetExtensions ( ) const

overridevirtual

Gets list of supported file extensions.

Returns: list of extensions

Implements DE_ConfigurationNode.

◆ GetFormat()

virtual TCollection_AsciiString Vrml_ConfigurationNode::GetFormat ( ) const

overridevirtual

Gets CAD format name of associated provider.

Returns: provider CAD format

Implements DE_ConfigurationNode.

◆ GetVendor()

virtual TCollection_AsciiString Vrml_ConfigurationNode::GetVendor ( ) const

overridevirtual

Gets provider's vendor name of associated provider.

Returns: provider's vendor name

Implements DE_ConfigurationNode.

◆ IsExportSupported()

virtual bool Vrml_ConfigurationNode::IsExportSupported ( ) const

overridevirtual

Checks the export supporting.

Returns: true if export is supported

Reimplemented from DE_ConfigurationNode.

◆ IsImportSupported()

virtual bool Vrml_ConfigurationNode::IsImportSupported ( ) const

overridevirtual

Checks the import supporting.

Returns: true if import is supported

Reimplemented from DE_ConfigurationNode.

◆ Load()

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

overridevirtual

Updates values according the resource.

Parameters

[in] theResource input resource to use

Returns: true if theResource loading has ended correctly

Implements DE_ConfigurationNode.

◆ Save()

virtual TCollection_AsciiString Vrml_ConfigurationNode::Save ( ) const

overridevirtual

Writes configuration to the string.

Returns: result resource string

Implements DE_ConfigurationNode.

Field Documentation

◆ InternalParameters

struct Vrml_ConfigurationNode::Vrml_InternalSection Vrml_ConfigurationNode::InternalParameters

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

Vrml_ConfigurationNode.hxx

Data Structures

Public Types

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ WriteMode_RepresentationType

◆ WriteMode_WriterVersion

Constructor & Destructor Documentation

◆ Vrml_ConfigurationNode() [1/2]

◆ Vrml_ConfigurationNode() [2/2]

Member Function Documentation

◆ BuildProvider()

◆ Copy()

◆ GetExtensions()

◆ GetFormat()

◆ GetVendor()

◆ IsExportSupported()

◆ IsImportSupported()

◆ Load()

◆ Save()

Field Documentation

◆ InternalParameters