SoSFBox2s Class Reference

The SoSFBox2s class is a container for an SbBox2s vector. More...

#include <Inventor/fields/SoSFBox2s.h>

Inheritance diagram for SoSFBox2s:

Public Member Functions
virtual void	copyFrom (const SoField &field)
virtual SoType	getTypeId (void) const
void	getValue (SbBox2s &box) const
const SbBox2s &	getValue (void) const
virtual SbBool	isSame (const SoField &field) const
int	operator!= (const SoSFBox2s &field) const
const SbBox2s &	operator= (const SbBox2s &newvalue)
const SoSFBox2s &	operator= (const SoSFBox2s &field)
int	operator== (const SoSFBox2s &field) const
void	setValue (const SbBox2s &newvalue)
void	setValue (SbVec2s minvec, SbVec2s maxvec)
void	setValue (short xmin, short ymin, short xmax, short ymax)
Public Member Functions inherited from SoSField
virtual	~SoSField ()
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)
virtual void	countWriteRefs (SoOutput *out) const
void	disconnect (SoEngineOutput *engineoutput)
void	disconnect (SoField *field)
void	disconnect (void)
void	enableConnection (SbBool flag)
SbBool	enableNotify (SbBool on)
void	evaluate (void) const
virtual void	fixCopy (SbBool copyconnections)
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
virtual void	notify (SoNotList *nlist)
int	operator!= (const SoField &f) const
int	operator== (const SoField &f) const
virtual SbBool	read (SoInput *input, const SbName &name)
virtual SbBool	referencesCopy (void) const
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 SoSField
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 Attributes
SbBox2s	value

Additional Inherited Members
Public Types inherited from SoField
enum	FieldType { NORMAL_FIELD = 0 , EVENTIN_FIELD , EVENTOUT_FIELD , EXPOSED_FIELD }
Protected Member Functions inherited from SoSField
	SoSField (void)
Protected Member Functions inherited from SoField
	SoField (void)
virtual SoNotRec	createNotRec (SoBase *cont)
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

Detailed Description

The SoSFBox2s class is a container for an SbBox2s vector.

This field is used where nodes, engines or other field containers need to store a box.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

Coin 2.5

Member Function Documentation

copyFrom()

void SoSFBox2s::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.

createInstance()

void * SoSFBox2s::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.

getClassTypeId()

SoType SoSFBox2s::getClassTypeId ( void )

static

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

getTypeId()

SoType SoSFBox2s::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.

getValue()

void SoSFBox2s::getValue

(

SbBox2s &

box

)

const

Set value of vector.

initClass()

void SoSFBox2s::initClass ( void )

static

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

isSame()

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

virtual

Check for equal type and value(s).

Implements SoField.

setValue() [1/2]

void SoSFBox2s::setValue	(	SbVec2s	minvec,
		SbVec2s	maxvec )

Set value of vector.

setValue() [2/2]

void SoSFBox2s::setValue	(	short	xmin,
		short	ymin,
		short	xmax,
		short	ymax )

Set value of vector.

---

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

• SoSFBox2s.h
• SoSFBox2s.cpp