Coin: SoFieldContainer Class Reference

SoFieldContainer::SoFieldContainer ( void ) [protected]

Constructor.

SoFieldContainer::~SoFieldContainer ( ) [protected]

Destructor.

void SoFieldContainer::initClass ( void ) [static]

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

Reimplemented from SoBase.

SoType SoFieldContainer::getClassTypeId ( void ) [static]

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

Reimplemented from SoBase.

void SoFieldContainer::setToDefaults ( void )

This method sets all fields which we are parenting to their respective default values.

SbBool SoFieldContainer::hasDefaultValues ( void ) const

This method checks to see if the fields of this container have their default values, and returns TRUE if that is the case.

SbBool SoFieldContainer::fieldsAreEqual ( const SoFieldContainer * container ) const

This method returns TRUE if the values of the fields of this and container are equal.

void SoFieldContainer::copyFieldValues	(	const SoFieldContainer *	container,
		SbBool	copyconnections = `0`
	)

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

This method copies the field values from container into this. The fields are assumed to be of the same type. The copyconnections flag decides whether the field connections are to be copied aswell.

SbBool SoFieldContainer::set ( const char *const fielddata )

This method parses the values of one or more fields from the fielddata string.

The fields must be in the same format as the Open Inventor file format. TRUE is returned upon success, and FALSE otherwise.

See also:: get()

Reimplemented in SoBaseKit.

void SoFieldContainer::get ( SbString & fielddata )

This methods stores the field data in the given fielddata string. The format of the returned string follows the Open Inventor file format.

See also:: set()

int SoFieldContainer::getFields ( SoFieldList & fields ) const [virtual]

This method adds the fields in this container to the l argument, and returns the number of fields added.

The virtual nature of this function means that it can be overridden to e.g. hide private fields.

int SoFieldContainer::getAllFields ( SoFieldList & fields ) const [virtual]

Returns VRML eventIn and eventOut fields in addition to the "ordinary" fields.

See also:: getFields()

SoField * SoFieldContainer::getField ( const SbName & name ) const [virtual]

This method returns a pointer to the field with name, or NULL if no such field exists.

SoField * SoFieldContainer::getEventIn ( const SbName & name ) const [virtual]

This method returns a pointer to the eventIn with name name, or NULL if no such eventIn exists.

SoField * SoFieldContainer::getEventOut ( const SbName & name ) const [virtual]

This method returns a pointer to the eventOut with name name, or NULL if no such eventOut exists.

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

Finds the name of the given field and returns the value in the name argument.

TRUE is returned if the field is contained within this instance, and FALSE otherwise.

SbBool SoFieldContainer::enableNotify ( const SbBool enable )

This method sets whether notification will be propagated on changing the values of the contained fields. The old value of the flag is returned.

Notification is default on. Turning off automatic notification can be useful for optimizing performance. During series of updates you may want to avoid the propagation of notifications upon every field value change if you make a lot of them. This is how you should handle those cases:

  SbBool autonotify = node->enableNotify(FALSE);
  // ...
  // Make modifications to fields of "node" here.
  // ...
  node->enableNotify(autonotify);
  node->touch();

See also:: isNotifyEnabled()

SbBool SoFieldContainer::isNotifyEnabled ( void ) const

This method returns whether notification of changes to the field values in the container is propagated to its auditors.

See also:: enableNotify()

SbBool SoFieldContainer::set	(	const char *	fielddata,
		SoInput *	in
	)

This method parses the values of one or more fields from the fielddata string.

The fields must be in the same format as the Open Inventor file format. TRUE is returned upon success, and FALSE otherwise.

We use the reference dictionary provided by in.

See also:: get()

void SoFieldContainer::get	(	SbString &	fielddata,
		SoOutput *	out
	)

Put names and values of fields from this instance in the fielddata string. Fields will be separated in the returned string by end-of-line characters.

We use the reference dictionary provided by out.

See also:: set()

void SoFieldContainer::notify ( SoNotList * l ) [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoBase.

Reimplemented in SoEngine, SoNodeEngine, SoAsciiText, SoBlinker, SoBumpMap, SoImage, SoLOD, SoLevelOfDetail, SoMaterial, SoNode, SoPackedColor, SoSceneTexture2, SoSeparator, SoShape, SoSwitch, SoText3, SoTexture2, SoTexture3, SoTextureCubeMap, SoVertexProperty, SoVertexShape, SoVRMLAppearance, SoVRMLBillboard, SoVRMLCollision, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLGeometry, SoVRMLGroup, SoVRMLIndexedLine, SoVRMLIndexedShape, SoVRMLLOD, SoVRMLParent, SoVRMLPixelTexture, SoVRMLProximitySensor, SoVRMLScript, SoVRMLShape, SoVRMLSwitch, SoVRMLText, SoVRMLTimeSensor, SoVRMLTouchSensor, SoVRMLTransform, SoVRMLVertexLine, SoVRMLVertexPoint, SoVRMLVertexShape, and SoShadowGroup.

SbBool SoFieldContainer::validateNewFieldValue	(	SoField *	field,
		void *	newval
	)			`[virtual]`

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. I can't make head or tails of this method, it seems to return TRUE no matter what the arguments are.

void SoFieldContainer::addWriteReference	(	SoOutput *	out,
		SbBool	isfromfield = `0`
	)			`[virtual]`

This method is used during the first write pass of a write action to count the number of references to this object in the scene graph.

Reimplemented from SoBase.

Reimplemented in SoBaseKit.

void SoFieldContainer::writeInstance ( SoOutput * out ) [virtual]

Writes all the fields contained in this instance to the output stream within out.

This method is solely called from the write methods of fields.

Either from SoField if the write is done because of a field-to-field connection, or from one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode, SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.

This method, in addition to the ordinary write() method of SoNode, needs to be present since the fields don't have a write action instance in their writeValue() method, and writeInstance() will create a new SoWriteAction and call continueToApply() on it.

Reimplemented in SoElapsedTime, SoEngine, SoTimeCounter, SoNodeEngine, and SoNode.

SbBool SoFieldContainer::getIsBuiltIn ( void ) const

Returns TRUE if this object is instantiated from one of the native Coin classes, FALSE if the object's class is outside the standard Coin library.

const SoFieldData * SoFieldContainer::getFieldData ( void ) const [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.


Public Member Functions
void	setToDefaults (void)
SbBool	hasDefaultValues (void) const
SbBool	fieldsAreEqual (const SoFieldContainer *container) const
void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
SbBool	set (const char *const fielddata)
void	get (SbString &fielddata)
virtual int	getFields (SoFieldList &l) const
virtual int	getAllFields (SoFieldList &l) const
virtual SoField *	getField (const SbName &name) const
virtual SoField *	getEventIn (const SbName &name) const
virtual SoField *	getEventOut (const SbName &name) const
SbBool	getFieldName (const SoField *const field, SbName &name) const
SbBool	enableNotify (const SbBool flag)
SbBool	isNotifyEnabled (void) const
SbBool	set (const char fielddata, SoInput in)
void	get (SbString &fielddata, SoOutput *out)
virtual void	notify (SoNotList *l)
virtual SbBool	validateNewFieldValue (SoField field, void newval)
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=0)
virtual void	writeInstance (SoOutput *out)
SbBool	getIsBuiltIn (void) const
virtual const SoFieldData *	getFieldData (void) const
virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer *	copyThroughConnection (void) const
void	setUserData (void *userdata) const
void *	getUserData (void) const
Static Public Member Functions
static void	initClass (void)
static SoType	getClassTypeId (void)
static void	initCopyDict (void)
static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
static void	copyDone (void)
Protected Member Functions
	SoFieldContainer (void)
	~SoFieldContainer ()
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
Protected Attributes
SbBool	isBuiltIn

SoFieldContainer Class Reference
[General classes]

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

SoFieldContainer Class Reference [General classes]

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

SoFieldContainer Class Reference
[General classes]