#include <VrmlData_Group.hxx>

Inheritance diagram for VrmlData_Group:

[legend]

Public Types
typedef VrmlData_ListOfNode::Iterator	Iterator

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

Public Member Functions
	VrmlData_Group (const Standard_Boolean isTransform=Standard_False)

	VrmlData_Group (const VrmlData_Scene &theScene, const char *theName, const Standard_Boolean isTransform=Standard_False)

Handle< VrmlData_Node > &	AddNode (const Handle< VrmlData_Node > &theNode)

Standard_Boolean	RemoveNode (const Handle< VrmlData_Node > &theNode)

Iterator	NodeIterator () const

const Bnd_B3f &	Box () const

void	SetBox (const Bnd_B3f &theBox)

Standard_Boolean	SetTransform (const gp_Trsf &theTrsf)

const gp_Trsf &	GetTransform () const

Standard_Boolean	IsTransform () const

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

virtual VrmlData_ErrorStatus	Read (VrmlData_InBuffer &theBuffer) override

virtual VrmlData_ErrorStatus	Write (const char *thePrefix) const override

Handle< VrmlData_Node >	FindNode (const char *theName, gp_Trsf &theLocation) const

void	Shape (TopoDS_Shape &theShape, VrmlData_DataMapOfShapeAppearance *pMapApp)

Public Member Functions inherited from VrmlData_Node
	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 Standard_Boolean	IsDefault () const

VrmlData_ErrorStatus	WriteClosing () const

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.

Protected Member Functions
VrmlData_ErrorStatus	openFile (Standard_IStream &theStream, const TCollection_AsciiString &theFilename)

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

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

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

Detailed Description

Implementation of node "Group"

Member Typedef Documentation

◆ Iterator

typedef VrmlData_ListOfNode::Iterator VrmlData_Group::Iterator

Constructor & Destructor Documentation

◆ VrmlData_Group() [1/2]

VrmlData_Group::VrmlData_Group ( const Standard_Boolean isTransform = Standard_False )

inline

Empty constructor.

Parameters

isTransform	True if the group of type Transform is defined
theAlloc	Allocator used for the list of children

◆ VrmlData_Group() [2/2]

VrmlData_Group::VrmlData_Group	(	const VrmlData_Scene &	theScene,
		const char *	theName,
		const Standard_Boolean	isTransform = `Standard_False`
	)

Constructor.

Parameters

theName	Name of the Group node
isTransform	True if the group of type Transform is defined
theAlloc	Allocator used for the list of children

Member Function Documentation

◆ AddNode()

Handle< VrmlData_Node > & VrmlData_Group::AddNode ( const Handle< VrmlData_Node > & theNode )

inline

Add one node to the Group.

◆ Box()

const Bnd_B3f & VrmlData_Group::Box ( ) const

inline

Query the bounding box.

◆ Clone()

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

overridevirtual

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.

Reimplemented from VrmlData_Node.

◆ FindNode()

Handle< VrmlData_Node > VrmlData_Group::FindNode	(	const char *	theName,
		gp_Trsf &	theLocation
	)		const

Find a node by its name, inside this Group

Parameters

theName	Name of the node to search for.
theLocation	Location of the found node with respect to this Group.

◆ GetTransform()

const gp_Trsf & VrmlData_Group::GetTransform ( ) const

inline

Query the transform value. For group without transformation this always returns Identity

◆ IsTransform()

Standard_Boolean VrmlData_Group::IsTransform ( ) const

inline

Query if the node is Transform type.

◆ NodeIterator()

Iterator VrmlData_Group::NodeIterator ( ) const

inline

Create iterator on nodes belonging to the Group.

◆ openFile()

VrmlData_ErrorStatus VrmlData_Group::openFile	(	Standard_IStream &	theStream,
		const TCollection_AsciiString &	theFilename
	)

protected

Try to open a file by the given filename, using the search directories list myVrmlDir of the Scene.

◆ Read()

virtual VrmlData_ErrorStatus VrmlData_Group::Read ( VrmlData_InBuffer & theBuffer )

overridevirtual

Fill the Node internal data from the given input stream.

Implements VrmlData_Node.

◆ RemoveNode()

Standard_Boolean VrmlData_Group::RemoveNode ( const Handle< VrmlData_Node > & theNode )

Remove one node from the Group.

Returns: True if the node was located and removed, False if none removed.

◆ SetBox()

void VrmlData_Group::SetBox ( const Bnd_B3f & theBox )

inline

Set the bounding box.

◆ SetTransform()

Standard_Boolean VrmlData_Group::SetTransform ( const gp_Trsf & theTrsf )

Set the transformation. Returns True if the group is Transform type, otherwise do nothing and return False.

◆ Shape()

void VrmlData_Group::Shape	(	TopoDS_Shape &	theShape,
		VrmlData_DataMapOfShapeAppearance *	pMapApp
	)

Get the shape representing the group geometry.

◆ Write()

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

overridevirtual

Write the Node to output stream.

Reimplemented from VrmlData_Node.

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

VrmlData_Group.hxx

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Iterator

Constructor & Destructor Documentation

◆ VrmlData_Group() [1/2]

◆ VrmlData_Group() [2/2]

Member Function Documentation

◆ AddNode()

◆ Box()

◆ Clone()

◆ FindNode()

◆ GetTransform()

◆ IsTransform()

◆ NodeIterator()

◆ openFile()

◆ Read()

◆ RemoveNode()

◆ SetBox()

◆ SetTransform()

◆ Shape()

◆ Write()