Detailed Description

DtVortexSimArtPartDescriptor extends the base simulation articulated part descriptor with Vortex-specific naming information. This allows articulated parts to be correctly mapped to their corresponding parts in the Vortex physics simulation.

#include <vortexArtPartDescriptor.h>

Inheritance diagram for makVre::DtVortexSimArtPartDescriptor:

[legend]

Public Member Functions
	DtVortexSimArtPartDescriptor ()

	DtVortexSimArtPartDescriptor (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtVortexSimArtPartDescriptor (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtVortexSimArtPartDescriptor (const DtString &partName, const DtVortexSimArtPartDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtVortexSimArtPartDescriptor (const DtSymbolString &partName, const DtVortexSimArtPartDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtVortexSimArtPartDescriptor &	operator= (const DtVortexSimArtPartDescriptor &orig)

virtual	~DtVortexSimArtPartDescriptor () override

virtual DtVortexSimArtPartDescriptor *	clone (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const override

virtual DtVortexSimArtPartDescriptor *	clone (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const override

virtual void	setVortexPartName (const std::string &partType)

virtual std::string	vortexPartName () const

virtual const char *	readerWriterType () const override

virtual const char *	xmlType () const override

Static Public Member Functions
static const char *	theXmlType ()

Protected Attributes
DtRwString	myVortexPartName

Constructor & Destructor Documentation

◆ DtVortexSimArtPartDescriptor() [1/5]

makVre::DtVortexSimArtPartDescriptor::DtVortexSimArtPartDescriptor ( )

Default constructor.

Creates an empty descriptor with default values

Referenced by clone(), clone(), DtVortexSimArtPartDescriptor(), DtVortexSimArtPartDescriptor(), and operator=().

◆ DtVortexSimArtPartDescriptor() [2/5]

makVre::DtVortexSimArtPartDescriptor::DtVortexSimArtPartDescriptor	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with part name and registry.

Parameters

partName	Name of the articulated part
parentRegistry	Optional parent registry for reader/writer operations

◆ DtVortexSimArtPartDescriptor() [3/5]

makVre::DtVortexSimArtPartDescriptor::DtVortexSimArtPartDescriptor	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with symbol part name and registry.

Parameters

partName	Symbol string name of the articulated part
parentRegistry	Optional parent registry for reader/writer operations

◆ DtVortexSimArtPartDescriptor() [4/5]

makVre::DtVortexSimArtPartDescriptor::DtVortexSimArtPartDescriptor	(	const DtString &	partName,
		const DtVortexSimArtPartDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Copy constructor with new part name.

Parameters

partName	New name for the copied articulated part
orig	Original descriptor to copy from
parentRegistry	Optional parent registry for reader/writer operations

References DtVortexSimArtPartDescriptor().

◆ DtVortexSimArtPartDescriptor() [5/5]

makVre::DtVortexSimArtPartDescriptor::DtVortexSimArtPartDescriptor	(	const DtSymbolString &	partName,
		const DtVortexSimArtPartDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Copy constructor with new symbol part name.

Parameters

partName	New symbol string name for the copied articulated part
orig	Original descriptor to copy from
parentRegistry	Optional parent registry for reader/writer operations

References DtVortexSimArtPartDescriptor().

◆ ~DtVortexSimArtPartDescriptor()

virtual makVre::DtVortexSimArtPartDescriptor::~DtVortexSimArtPartDescriptor ( )

overridevirtual

Virtual destructor.

Member Function Documentation

◆ operator=()

DtVortexSimArtPartDescriptor & makVre::DtVortexSimArtPartDescriptor::operator= ( const DtVortexSimArtPartDescriptor & orig )

Assignment operator.

Parameters

orig	Original descriptor to copy from

Returns: Reference to this descriptor after assignment

References DtVortexSimArtPartDescriptor().

◆ clone() [1/2]

virtual DtVortexSimArtPartDescriptor * makVre::DtVortexSimArtPartDescriptor::clone	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL ) const

overridevirtual

Creates a clone of this descriptor with a new part name.

Parameters

partName	New name for the cloned articulated part
parentRegistry	Optional parent registry for reader/writer operations

Returns: Pointer to a new descriptor that is a copy of this one

References DtVortexSimArtPartDescriptor().

◆ clone() [2/2]

virtual DtVortexSimArtPartDescriptor * makVre::DtVortexSimArtPartDescriptor::clone	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL ) const

overridevirtual

Creates a clone of this descriptor with a new symbol part name.

Parameters

partName	New symbol string name for the cloned articulated part
parentRegistry	Optional parent registry for reader/writer operations

Returns: Pointer to a new descriptor that is a copy of this one

References DtVortexSimArtPartDescriptor().

◆ setVortexPartName()

virtual void makVre::DtVortexSimArtPartDescriptor::setVortexPartName ( const std::string & partType )

virtual

Sets the Vortex-specific part name.

Parameters

partType The part name used within the Vortex physics simulation

◆ vortexPartName()

virtual std::string makVre::DtVortexSimArtPartDescriptor::vortexPartName ( ) const

virtual

Gets the Vortex-specific part name.

Returns: The part name used within the Vortex physics simulation

◆ readerWriterType()

virtual const char * makVre::DtVortexSimArtPartDescriptor::readerWriterType ( ) const

overridevirtual

Gets the type identifier for reader/writer operations.

Returns: Type identifier string

◆ theXmlType()

static const char * makVre::DtVortexSimArtPartDescriptor::theXmlType ( )

static

Gets the XML type identifier for serialization.

Returns: XML type identifier string used when archiving to an XML stream

Referenced by xmlType().

◆ xmlType()

virtual const char * makVre::DtVortexSimArtPartDescriptor::xmlType ( ) const

inlineoverridevirtual

Gets the XML type identifier for this instance.

Returns: XML type identifier string

References theXmlType().

Member Data Documentation

◆ myVortexPartName

DtRwString makVre::DtVortexSimArtPartDescriptor::myVortexPartName

protected

The Vortex-specific part name used in the physics simulation.

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

include/vrfExtensions/vreVrfVortexObjparam/vortexArtPartDescriptor.h

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DtVortexSimArtPartDescriptor() [1/5]

◆ DtVortexSimArtPartDescriptor() [2/5]

◆ DtVortexSimArtPartDescriptor() [3/5]

◆ DtVortexSimArtPartDescriptor() [4/5]

◆ DtVortexSimArtPartDescriptor() [5/5]

◆ ~DtVortexSimArtPartDescriptor()

Member Function Documentation

◆ operator=()

◆ clone() [1/2]

◆ clone() [2/2]

◆ setVortexPartName()

◆ vortexPartName()

◆ readerWriterType()

◆ theXmlType()

◆ xmlType()

Member Data Documentation

◆ myVortexPartName