The SoMFPath class is a container for paths. More...

#include <Inventor/fields/SoMFPath.h>

Inheritance diagram for SoMFPath:

Public Member Functions
virtual void	copyFrom (const SoField &field)

virtual void	deleteValues (int start, int num=-1)

int	find (SoPath *value, SbBool addifnotfound=FALSE)

void	finishEditing (void)

virtual void	fixCopy (SbBool copyconnections)

virtual SoType	getTypeId (void) const

const SoPath **	getValues (const int start) const

virtual void	insertSpace (int start, int num)

virtual SbBool	isSame (const SoField &field) const

virtual void	notify (SoNotList *l)

SbBool	operator!= (const SoMFPath &field) const

const SoMFPath &	operator= (const SoMFPath &field)

SoPath *	operator= (SoPath *val)

SbBool	operator== (const SoMFPath &field) const

SoPath *	operator[] (const int idx) const

virtual SbBool	referencesCopy (void) const

void	set1Value (const int idx, SoPath *value)

void	setValue (SoPath *value)

void	setValues (const int start, const int num, const SoPath **newvals)

SoPath **	startEditing (void)

Public Member Functions inherited from SoMField
virtual	~SoMField ()

virtual void	enableDeleteValues (void)

void	get1 (const int index, SbString &valuestring)

int	getNum (void) const

virtual SbBool	isDeleteValuesEnabled (void) const

SbBool	set1 (const int index, const char *const valuestring)

void	setNum (const int num)

Public Member Functions inherited from SoField
virtual	~SoField ()

void	addAuditor (void *f, SoNotRec::Type type)

SbBool	appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)

SbBool	appendConnection (SoField *master, SbBool notnotify=FALSE)

SbBool	connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)

SbBool	connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)

virtual void	connectionStatusChanged (int numconnections)

void	copyConnection (const SoField *fromfield)

void	disconnect (SoEngineOutput *engineoutput)

void	disconnect (SoField *field)

void	disconnect (void)

void	enableConnection (SbBool flag)

SbBool	enableNotify (SbBool on)

void	evaluate (void) const

void	get (SbString &valuestring)

SbBool	getConnectedEngine (SoEngineOutput *&master) const

SbBool	getConnectedField (SoField *&master) const

int	getConnections (SoFieldList &masterlist) const

SoFieldContainer *	getContainer (void) const

SbBool	getDirty (void) const

int	getFieldType (void) const

int	getForwardConnections (SoFieldList &slavelist) const

int	getNumConnections (void) const

SbBool	isConnected (void) const

SbBool	isConnectedFromEngine (void) const

SbBool	isConnectedFromField (void) const

SbBool	isConnectionEnabled (void) const

SbBool	isDefault (void) const

SbBool	isIgnored (void) const

SbBool	isNotifyEnabled (void) const

SbBool	isOfType (const SoType type) const

SbBool	isReadOnly (void) const

int	operator!= (const SoField &f) const

int	operator== (const SoField &f) const

virtual SbBool	read (SoInput *input, const SbName &name)

void	removeAuditor (void *f, SoNotRec::Type type)

SbBool	set (const char *valuestring)

void	setContainer (SoFieldContainer *cont)

void	setDefault (SbBool defaultVal)

void	setDirty (SbBool dirty)

void	setFieldType (int type)

void	setIgnored (SbBool ignore)

SbBool	shouldWrite (void) const

virtual void	startNotify (void)

virtual void	touch (void)

virtual void	write (SoOutput *out, const SbName &name) const

Static Public Member Functions
static void *	createInstance (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoMField
static void	atexit_cleanup (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoField
static void	cleanupClass (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

static void	initClasses (void)

Protected Member Functions
virtual void	allocValues (int num)

virtual void	copyValue (int to, int from)

virtual void	deleteAllValues (void)

virtual int	fieldSizeof (void) const

virtual void	setValuesPtr (void *ptr)

virtual void *	valuesPtr (void)

Protected Member Functions inherited from SoMField
	SoMField (void)

virtual SoNotRec	createNotRec (SoBase *container)

virtual void	makeRoom (int newnum)

void	setChangedIndex (const int chgidx)

void	setChangedIndices (const int chgidx=-1, const int numchgind=0)

Protected Member Functions inherited from SoField
	SoField (void)

virtual void	evaluateConnection (void) const

SbBool	isDestructing (void) const

virtual SbBool	readConnection (SoInput *in)

void	valueChanged (SbBool resetdefault=TRUE)

virtual void	writeConnection (SoOutput *out) const

Protected Attributes
SoPath **	values

Protected Attributes inherited from SoMField
int	maxNum

int	num

SbBool	userDataIsUsed

Additional Inherited Members
Public Types inherited from SoField
enum	FieldType { NORMAL_FIELD = 0 , EVENTIN_FIELD , EVENTOUT_FIELD , EXPOSED_FIELD }

Detailed Description

The SoMFPath class is a container for paths.

This field container stores an array of pointers to paths. It takes care of the necessary functionality for handling copy, import and export operations.

Note that path pointers stored in field instances of this type may be NULL pointers.

See also: SoPath, SoSFPath

Member Function Documentation

◆ copyFrom()

void SoMFPath::copyFrom ( const SoField & f )

virtual

Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

◆ copyValue()

virtual void SoMFPath::copyValue	(	int	to,
		int	from )

protectedvirtual

Implements SoMField.

◆ createInstance()

void * SoMFPath::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

◆ deleteAllValues()

virtual void SoMFPath::deleteAllValues ( void )

protectedvirtual

Implements SoMField.

◆ deleteValues()

virtual void SoMFPath::deleteValues	(	int	start,
		int	numarg = -1 )

virtual

Remove value elements from index start up to and including index start + num - 1.

Elements with indices larger than the last deleted element will be moved downwards in the value array.

If num equals -1, delete from index start and to the end of the array.

Reimplemented from SoMField.

◆ fixCopy()

void SoMFPath::fixCopy ( SbBool copyconnections )

virtual

This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing.

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation.

Reimplemented from SoField.

◆ getClassTypeId()

SoType SoMFPath::getClassTypeId ( void )

static

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

◆ getTypeId()

SoType SoMFPath::getTypeId ( void ) const

virtual

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

Implements SoField.

◆ getValues()

const SoPath ** SoMFPath::getValues ( const int start ) const

inline

Returns a pointer to the values array.

◆ initClass()

void SoMFPath::initClass ( void )

static

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

◆ insertSpace()

virtual void SoMFPath::insertSpace	(	int	start,
		int	numarg )

virtual

Insert num "slots" for new value elements from start. The elements already present from start will be moved "upward" in the extended array.

Reimplemented from SoMField.

◆ isSame()

SbBool SoMFPath::isSame ( const SoField & f ) const

virtual

Check for equal type and value(s).

Implements SoField.

◆ notify()

void SoMFPath::notify ( SoNotList * nlist )

virtual

Notify auditors that this field has changed.

Reimplemented from SoField.

◆ referencesCopy()

SbBool SoMFPath::referencesCopy ( void ) const

virtual

Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

Note that this method only is valid to call during copy operations.

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method as well.

Reimplemented from SoField.

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

SoMFPath.h
SoMFPath.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyFrom()

◆ copyValue()

◆ createInstance()

◆ deleteAllValues()

◆ deleteValues()

◆ fixCopy()

◆ getClassTypeId()

◆ getTypeId()

◆ getValues()

◆ initClass()

◆ insertSpace()

◆ isSame()

◆ notify()

◆ referencesCopy()