The SoFieldConverter class is the abstract base class for field converters. More...

#include <Inventor/engines/SoFieldConverter.h>

Inheritance diagram for SoFieldConverter:

Public Member Functions
virtual SoField *	getConnectedInput (void)

virtual const SoFieldData *	getFieldData (void) const

int	getForwardConnections (SoFieldList &l) const

virtual SoField *	getInput (SoType type)=0

virtual SoEngineOutput *	getOutput (SoType type)=0

virtual const SoEngineOutputData *	getOutputData (void) const

virtual SoType	getTypeId (void) const

Public Member Functions inherited from SoEngine
SoEngine *	copy (void) const

virtual SoFieldContainer *	copyThroughConnection (void) const

void	evaluateWrapper (void)

SoEngineOutput *	getOutput (const SbName &outputname) const

SbBool	getOutputName (const SoEngineOutput *output, SbName &outputname) const

virtual int	getOutputs (SoEngineOutputList &l) const

SbBool	isNotifying (void) const

virtual void	notify (SoNotList *nl)

SbBool	shouldCopy (void) const

virtual void	writeInstance (SoOutput *out)

Public Member Functions inherited from SoFieldContainer
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	enableNotify (const SbBool flag)

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	get (SbString &fielddata)

void	get (SbString &fielddata, SoOutput *out)

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

virtual SoField *	getField (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

virtual int	getFields (SoFieldList &l) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

SbBool	getIsBuiltIn (void) const

void *	getUserData (void) const

SbBool	hasDefaultValues (void) const

SbBool	isNotifyEnabled (void) const

SbBool	set (const char *const fielddata)

SbBool	set (const char fielddata, SoInput input)

void	setToDefaults (void)

void	setUserData (void *userdata) const

virtual SbBool	validateNewFieldValue (SoField field, void newval)

Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	assertAlive (void) const

const SoAuditorList &	getAuditors (void) const

virtual SbName	getName (void) const

int32_t	getRefCount (void) const

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type.

void	ref (void) const

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

virtual void	setName (const SbName &newname)

SbBool	shouldWrite (void)

virtual void	startNotify (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static SoType	getClassTypeId (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initClasses (void)

Static Public Member Functions inherited from SoEngine
static SoEngine *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoEngineList &el)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initClasses (void)

Static Public Member Functions inherited from SoFieldContainer
static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static void	cleanupClass (void)

static void	copyDone (void)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initCopyDict (void)

Static Public Member Functions inherited from SoBase
static void	addName (SoBase const base, const char const name)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static void	decrementCurrentWriteCounter (void)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	getTraceRefs (void)

static void	incrementCurrentWriteCounter (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static SbBool	readRoute (SoInput *input)

static void	removeName (SoBase const base, const char const name)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

Protected Member Functions
	SoFieldConverter (void)

virtual	~SoFieldConverter (void)

Protected Member Functions inherited from SoEngine
	SoEngine (void)

virtual	~SoEngine (void)

virtual void	evaluate (void)=0

virtual void	inputChanged (SoField *which)

virtual SbBool	readInstance (SoInput *in, unsigned short flags)

void	writeOutputTypes (SoOutput *out)

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual SoNotRec	createNotRec (void)

virtual const char *	getFileFormatName (void) const

SbBool	hasMultipleWriteRefs (void) const

void	writeFooter (SoOutput *out) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

Static Protected Member Functions
static const SoFieldData **	getInputDataPtr (void)

static const SoEngineOutputData **	getOutputDataPtr (void)

Static Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr (void)

static const SoEngineOutputData **	getOutputDataPtr (void)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Detailed Description

The SoFieldConverter class is the abstract base class for field converters.

When fields of different types are attempted connected, the Coin library tries to find a field converter class which can be inserted between them, acting as a filter converting values from the master field to values matching the type of the slave field.

If a value type conversion is possible (like between an SoSFFloat field and an SoSFInt32 field, for instance, where we could do a simple typecast for converting the value of one to the other), an SoFieldConverter derived object is inserted.

This class is the abstract base superclass which all such field converters needs to inherit.

Coin comes with one built-in field converter class which takes care of all possible field-to-field conversions we know about. This means applications programmers should seldom need to care about this class, it will probably only be useful if you expand the Coin library with your own field type classes. (Doing so is considered advanced use of the library.)

See also: SoDB::addConverter()

Constructor & Destructor Documentation

◆ SoFieldConverter()

SoFieldConverter::SoFieldConverter ( void )

protected

Default constructor.

◆ ~SoFieldConverter()

SoFieldConverter::~SoFieldConverter ( void )

protectedvirtual

Default destructor.

Member Function Documentation

◆ getClassTypeId()

SoType SoFieldConverter::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getConnectedInput()

SoField * SoFieldConverter::getConnectedInput ( void )

virtual

This method is obsoleted in Coin. It should probably have been private in OIV.

◆ getFieldData()

const SoFieldData * SoFieldConverter::getFieldData ( void ) const

virtual

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoFieldContainer.

◆ getForwardConnections()

int SoFieldConverter::getForwardConnections ( SoFieldList & l ) const

Returns fields which are connected as slaves of the engine output.

◆ getInput()

SoField * SoFieldConverter::getInput ( SoType type )

pure virtual

Returns input field for the converter engine. Must be overridden in non-abstract converter engine classes.

◆ getInputDataPtr()

const SoFieldData ** SoFieldConverter::getInputDataPtr ( void )

staticprotected

Returns the SoFieldData class which holds information about inputs in this engine.

◆ getOutput()

SoEngineOutput * SoFieldConverter::getOutput ( SoType type )

pure virtual

Returns output for the converter engine. Must be overridden in non-abstract converter engine classes.

◆ getOutputData()

const SoEngineOutputData * SoFieldConverter::getOutputData ( void ) const

virtual

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Implements SoEngine.

◆ getOutputDataPtr()

const SoEngineOutputData ** SoFieldConverter::getOutputDataPtr ( void )

staticprotected

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

◆ getTypeId()

SoType SoFieldConverter::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

◆ initClasses()

void SoFieldConverter::initClasses ( void )

static

Initializes all field conversions. Automatically called from SoFieldConverter::initClass() upon initialization of Coin.

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

SoFieldConverter.h
SoFieldConverter.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoFieldConverter()

◆ ~SoFieldConverter()

Member Function Documentation

◆ getClassTypeId()

◆ getConnectedInput()

◆ getFieldData()

◆ getForwardConnections()

◆ getInput()

◆ getInputDataPtr()

◆ getOutput()

◆ getOutputData()

◆ getOutputDataPtr()

◆ getTypeId()

◆ initClasses()