Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions
VrmlData_Node Class Reference

#include <VrmlData_Node.hxx>

Inheritance diagram for VrmlData_Node:
Inheritance graph
[legend]

Public Member Functions

 VrmlData_Node ()
virtual ~VrmlData_Node ()
const VrmlData_SceneScene () 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_NodeClone (const Handle< VrmlData_Node > &) const

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 ()

Protected Member Functions

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

Static Protected Member Functions

static VrmlData_ErrorStatus readBrace (VrmlData_InBuffer &theBuffer)

Detailed Description

Abstract VRML Node


Constructor & Destructor Documentation

Empty constructor

virtual VrmlData_Node::~VrmlData_Node ( ) [inline, virtual]

Destructor

VrmlData_Node::VrmlData_Node ( const VrmlData_Scene theScene,
const char *  theName 
) [protected]

Constructor


Member Function Documentation

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.

static Standard_Integer VrmlData_Node::GlobalIndent ( ) [inline, static]

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

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.

const char* VrmlData_Node::Name ( ) const [inline]

Query the name

static Standard_Boolean VrmlData_Node::OK ( const VrmlData_ErrorStatus  theStat) [inline, static]
static Standard_Boolean VrmlData_Node::OK ( VrmlData_ErrorStatus outStat,
const VrmlData_ErrorStatus  theStat 
) [inline, static]
virtual VrmlData_ErrorStatus VrmlData_Node::Read ( VrmlData_InBuffer theBuffer) [pure virtual]
static VrmlData_ErrorStatus VrmlData_Node::ReadBoolean ( VrmlData_InBuffer theBuffer,
Standard_Boolean theResult 
) [static]

Read one boolean value (TRUE or FALSE).

static VrmlData_ErrorStatus VrmlData_Node::readBrace ( VrmlData_InBuffer theBuffer) [static, protected]

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

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

Read one integer value.

Read one quoted string, the quotes are removed.

Read a complete node definition from VRML stream

Parameters:
theBufferBuffer receiving the input data.
theNode[out] Node restored from the buffer data
TypeNode 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.

Read one quoted string, the quotes are removed.

Query the Scene that contains this Node

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

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


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