VrmlData_WorldInfo Class Reference

#include <VrmlData_WorldInfo.hxx>

Inheritance diagram for VrmlData_WorldInfo:

Public Member Functions
	VrmlData_WorldInfo ()
	VrmlData_WorldInfo (const VrmlData_Scene &theScene, const char *theName=nullptr, const char *theTitle=nullptr)
void	SetTitle (const char *theString)
void	AddInfo (const char *theString)
const char *	Title () const
NCollection_List< constchar * >::Iterator	InfoIterator () const
occ::handle< VrmlData_Node >	Clone (const occ::handle< VrmlData_Node > &theOther) const override
VrmlData_ErrorStatus	Read (VrmlData_InBuffer &theBuffer) override
VrmlData_ErrorStatus	Write (const char *thePrefix) const override
bool	IsDefault () const override
Public Member Functions inherited from VrmlData_Node
	VrmlData_Node ()
	~VrmlData_Node () override=default
const VrmlData_Scene &	Scene () const
const char *	Name () const
VrmlData_ErrorStatus	ReadNode (VrmlData_InBuffer &theBuffer, occ::handle< VrmlData_Node > &theNode, const occ::handle< Standard_Type > &Type=nullptr)
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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from VrmlData_Node
static VrmlData_ErrorStatus	ReadBoolean (VrmlData_InBuffer &theBuffer, bool &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 bool	OK (const VrmlData_ErrorStatus theStat)
static bool	OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
static int	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.
Protected Member Functions inherited from VrmlData_Node
	VrmlData_Node (const VrmlData_Scene &theScene, const char *theName)
Static Protected Member Functions inherited from VrmlData_Node
static VrmlData_ErrorStatus	readBrace (VrmlData_InBuffer &theBuffer)

Detailed Description

Data type for WorldInfo node

Constructor & Destructor Documentation

VrmlData_WorldInfo() [1/2]

VrmlData_WorldInfo::VrmlData_WorldInfo ( )

inline

Empty Constructor.

VrmlData_WorldInfo() [2/2]

VrmlData_WorldInfo::VrmlData_WorldInfo	(	const VrmlData_Scene &	theScene,
		const char *	theName = nullptr,
		const char *	theTitle = nullptr )

Constructor.

Member Function Documentation

AddInfo()

void VrmlData_WorldInfo::AddInfo

(

const char *

theString

)

Add a string to the list of info strings.

Clone()

occ::handle< VrmlData_Node > VrmlData_WorldInfo::Clone ( const occ::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.

InfoIterator()

NCollection_List< constchar * >::Iterator VrmlData_WorldInfo::InfoIterator ( ) const

inline

Return the iterator of Info strings.

IsDefault()

bool VrmlData_WorldInfo::IsDefault ( ) const

overridevirtual

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

Reimplemented from VrmlData_Node.

Read()

VrmlData_ErrorStatus VrmlData_WorldInfo::Read ( VrmlData_InBuffer & theBuffer )

overridevirtual

Read the Node from input stream.

Implements VrmlData_Node.

SetTitle()

void VrmlData_WorldInfo::SetTitle

(

const char *

theString

)

Set or modify the title.

Title()

const char * VrmlData_WorldInfo::Title ( ) const

inline

Query the title string.

Write()

VrmlData_ErrorStatus VrmlData_WorldInfo::Write ( const char * thePrefix ) const

overridevirtual

Write the Node to the Scene output.

Reimplemented from VrmlData_Node.

---

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

• VrmlData_WorldInfo.hxx