#include <VrmlData_Node.hxx>

Inheritance diagram for VrmlData_Node:

[legend]

Public Member Functions
	VrmlData_Node ()

virtual	~VrmlData_Node ()

const VrmlData_Scene &	Scene () const

const char *	Name () const

VrmlData_ErrorStatus	ReadNode (VrmlData_InBuffer &theBuffer, Handle< VrmlData_Node > &theNode, const Handle< Standard_Type > &Type=NULL)

virtual VrmlData_ErrorStatus	Read (VrmlData_InBuffer &theBuffer)=0

virtual VrmlData_ErrorStatus	Write (const char *thePrefix) const

virtual Standard_Boolean	IsDefault () const

VrmlData_ErrorStatus	WriteClosing () const

virtual Handle< VrmlData_Node >	Clone (const Handle< VrmlData_Node > &) const

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (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_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. 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 VrmlData_ErrorStatus	ReadBoolean (VrmlData_InBuffer &theBuffer, Standard_Boolean &theResult)

static VrmlData_ErrorStatus	ReadString (VrmlData_InBuffer &theBuffer, TCollection_AsciiString &theRes)

static VrmlData_ErrorStatus	ReadMultiString (VrmlData_InBuffer &theBuffer, NCollection_List< TCollection_AsciiString > &theRes)

static VrmlData_ErrorStatus	ReadInteger (VrmlData_InBuffer &theBuffer, long &theResult)

static Standard_Boolean	OK (const VrmlData_ErrorStatus theStat)

static Standard_Boolean	OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)

static Standard_Integer	GlobalIndent ()

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

Protected Member Functions
	VrmlData_Node (const VrmlData_Scene &theScene, const char *theName)

Static Protected Member Functions
static VrmlData_ErrorStatus	readBrace (VrmlData_InBuffer &theBuffer)

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

Detailed Description

Abstract VRML Node

Constructor & Destructor Documentation

◆ VrmlData_Node() [1/2]

VrmlData_Node::VrmlData_Node ( )

Empty constructor

◆ ~VrmlData_Node()

virtual VrmlData_Node::~VrmlData_Node ( )

inlinevirtual

Destructor

◆ VrmlData_Node() [2/2]

VrmlData_Node::VrmlData_Node	(	const VrmlData_Scene &	theScene,
		const char *	theName
	)

protected

Constructor

Member Function Documentation

◆ Clone()

virtual Handle< VrmlData_Node > VrmlData_Node::Clone ( const Handle< VrmlData_Node > & ) const

virtual

Create a copy of this node. If the parameter is null, a new copied node is created. Otherwise new node is not created, but rather the given one is modified.

This method nullifies the argument node if its member myScene differs from that one of the current instance.

Reimplemented in VrmlData_IndexedFaceSet, VrmlData_IndexedLineSet, VrmlData_Material, VrmlData_Group, VrmlData_Cylinder, VrmlData_Cone, VrmlData_Appearance, VrmlData_TextureCoordinate, VrmlData_Box, VrmlData_ShapeNode, VrmlData_WorldInfo, VrmlData_Color, VrmlData_Sphere, VrmlData_Coordinate, VrmlData_Normal, and VrmlData_ImageTexture.

◆ GlobalIndent()

static Standard_Integer VrmlData_Node::GlobalIndent ( )

inlinestatic

Define the common Indent in spaces, for writing all nodes.

◆ IsDefault()

virtual Standard_Boolean VrmlData_Node::IsDefault ( ) const

virtual

Returns True if the node is default, then it would not be written.

Reimplemented in VrmlData_IndexedFaceSet, VrmlData_IndexedLineSet, VrmlData_Material, VrmlData_Appearance, VrmlData_ArrayVec3d, VrmlData_ShapeNode, VrmlData_WorldInfo, and VrmlData_UnknownNode.

◆ Name()

const char* VrmlData_Node::Name ( ) const

inline

Query the name

◆ OK() [1/2]

static Standard_Boolean VrmlData_Node::OK ( const VrmlData_ErrorStatus theStat )

inlinestatic

◆ OK() [2/2]

static Standard_Boolean VrmlData_Node::OK	(	VrmlData_ErrorStatus &	outStat,
		const VrmlData_ErrorStatus	theStat
	)

inlinestatic

◆ Read()

virtual VrmlData_ErrorStatus VrmlData_Node::Read ( VrmlData_InBuffer & theBuffer )

pure virtual

Read the Node from input stream.

Implemented in VrmlData_IndexedFaceSet, VrmlData_IndexedLineSet, VrmlData_Material, VrmlData_Group, VrmlData_Cylinder, VrmlData_Cone, VrmlData_Appearance, VrmlData_TextureCoordinate, VrmlData_Box, VrmlData_ShapeNode, VrmlData_WorldInfo, VrmlData_Color, VrmlData_Sphere, VrmlData_Coordinate, VrmlData_Normal, VrmlData_ImageTexture, and VrmlData_UnknownNode.

◆ ReadBoolean()

static VrmlData_ErrorStatus VrmlData_Node::ReadBoolean	(	VrmlData_InBuffer &	theBuffer,
		Standard_Boolean &	theResult
	)

static

Read one boolean value (TRUE or FALSE).

◆ readBrace()

static VrmlData_ErrorStatus VrmlData_Node::readBrace ( VrmlData_InBuffer & theBuffer )

staticprotected

Read the closing brace. If successful, theBufrfer is incremented. If no brace is found, theBuffer stays in untouched and the method returns VrmlFormatError.

◆ ReadInteger()

static VrmlData_ErrorStatus VrmlData_Node::ReadInteger	(	VrmlData_InBuffer &	theBuffer,
		long &	theResult
	)

static

Read one integer value.

◆ ReadMultiString()

static VrmlData_ErrorStatus VrmlData_Node::ReadMultiString	(	VrmlData_InBuffer &	theBuffer,
		NCollection_List< TCollection_AsciiString > &	theRes
	)

static

Read one quoted string, the quotes are removed.

◆ ReadNode()

VrmlData_ErrorStatus VrmlData_Node::ReadNode	(	VrmlData_InBuffer &	theBuffer,
		Handle< VrmlData_Node > &	theNode,
		const Handle< Standard_Type > &	Type = `NULL`
	)

Read a complete node definition from VRML stream

Parameters

theBuffer	Buffer receiving the input data.
theNode	`[out]` Node restored from the buffer data
Type	Node type to be checked. If it is NULL(default) no type checking is done. Otherwise the created node is matched and an error is returned if no match detected.

◆ ReadString()

static VrmlData_ErrorStatus VrmlData_Node::ReadString	(	VrmlData_InBuffer &	theBuffer,
		TCollection_AsciiString &	theRes
	)

static

Read one quoted string, the quotes are removed.

◆ Scene()

const VrmlData_Scene& VrmlData_Node::Scene ( ) const

inline

Query the Scene that contains this Node

◆ Write()

virtual VrmlData_ErrorStatus VrmlData_Node::Write ( const char * thePrefix ) const

virtual

Write the Node to output stream.

Reimplemented in VrmlData_IndexedFaceSet, VrmlData_IndexedLineSet, VrmlData_Material, VrmlData_Group, VrmlData_Cylinder, VrmlData_Cone, VrmlData_Appearance, VrmlData_Box, VrmlData_ShapeNode, VrmlData_WorldInfo, VrmlData_Color, VrmlData_Sphere, VrmlData_Coordinate, VrmlData_Normal, and VrmlData_ImageTexture.

◆ WriteClosing()

VrmlData_ErrorStatus VrmlData_Node::WriteClosing ( ) const

Write the closing brace in the end of a node output.

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

VrmlData_Node.hxx

VrmlData_Node Class Referenceabstract

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VrmlData_Node() [1/2]

◆ ~VrmlData_Node()

◆ VrmlData_Node() [2/2]

Member Function Documentation

◆ Clone()

◆ GlobalIndent()

◆ IsDefault()

◆ Name()

◆ OK() [1/2]

◆ OK() [2/2]

◆ Read()

◆ ReadBoolean()

◆ readBrace()

◆ ReadInteger()

◆ ReadMultiString()

◆ ReadNode()

◆ ReadString()

◆ Scene()

◆ Write()

◆ WriteClosing()