A general-purpose calculator. More...

#include <Inventor/engines/SoCalculator.h>

Inheritance diagram for SoCalculator:

Public Attributes
Inputs
SoMFFloat	a
	Inputs a-h are the floating-point values.

SoMFFloat	b

SoMFFloat	c

SoMFFloat	d

SoMFFloat	e

SoMFFloat	f

SoMFFloat	g

SoMFFloat	h

SoMFVec3f	A
	Inputs A-H are the vectors.

SoMFVec3f	B

SoMFVec3f	C

SoMFVec3f	D

SoMFVec3f	E

SoMFVec3f	F

SoMFVec3f	G

SoMFVec3f	H

SoMFString	expression
	The expression to be evaluated.

Outputs
SoEngineOutput	oa
	(SoMFfloat)

SoEngineOutput	ob

SoEngineOutput	oc

SoEngineOutput	od

SoEngineOutput	oA
	(SoMFVec3f)

SoEngineOutput	oB

SoEngineOutput	oC

SoEngineOutput	oD

	SoCalculator ()
	Constructor.

static void	initClass ()

virtual void	inputChanged (SoField *whichInput)
	This is called whenever the value of an input is changed.

Additional Inherited Members
Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.

SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a pointer to the engine output with the given name.

bool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in `outputName`) the name of the engine output (`output`).

SoEngine *	copy () const
	Creates and returns an exact copy of the engine.

void	evaluateWrapper ()
	wrapper for the user's evaluate() engine

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

virtual const SoEngineOutputData *	getOutputData () const =0
	Info on outputs:

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.

bool	shouldCopy () const
	Recursive procedure that determines if this engine should be copied during a copy operation, or just referenced as is.

bool	isNotifying () const
	A very annoying double notification occurs with engines that enable their outputs during inputChanged; this flag prevents that:

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to `fc's` fields.

void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of `fc's` fields into this object's fields.

bool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.

bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the `fieldName` argument.

bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

bool	set (const char fieldDataString, SoInput dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.

void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.

virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.

void	unref () const

void	unrefNoDelete () const

void	touch ()
	Marks an instance as modified, simulating a change to it.

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type.

virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.

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

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.

int	getRefCount () const
	Returns current reference count.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.

Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.

static SoEngine *	getByName (const SbName &name)
	Look up engine(s) by name.

static int	getByName (const SbName &name, SoEngineList &list)
	Look up engine(s) by name.

static void	initClass ()
	Initializes base engine class.

static void	initClasses ()
	Initialize ALL Inventor engine classes.

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

static void	initClass ()
	Setup type information.

static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary.

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.

static void	copyDone ()
	Cleans up the dictionary when done.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

static void	initClass ()
	Setup type information.

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary.

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase.

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.

Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...

Protected Member Functions inherited from SoEngine
virtual void	evaluate ()=0
	User-written evaluation engine.

	SoEngine ()
	Constructor, destructor.

	~SoEngine ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.

virtual void	inputChanged (SoField *whichField)
	This is called whenever the value of an input is changed.

void	writeOutputTypes (SoOutput *out)
	Write output type information for engines that are not built-in.

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.

virtual void	destroy ()
	Actually deletes an instance.

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)

virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.

Static Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr ()
	This is used by the input&output inheritence mechanism, hidden in the SoSubEngine macros.

static const SoEngineOutputData **	getOutputDataPtr ()

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.

Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Detailed Description

This engine is a general-purpose calculator. The calculator operates on floating-point values and 3D floating-point vectors. The engine takes up to eight inputs of each type (SoMFFloat and SoMFVec3f), and produces up to four outputs of each type.

Each input field (a -h , A -H ) can have multiple values, allowing the engine to evaluate the expression with different values in parallel. Some inputs may have more values than others. In such cases, the last value of the shorter inputs will be repeated as necessary.

The expression input string specifies the expression to be evaluated. An expression can consist of multiple subexpressions. Several subexpressions can be specified in one string, separated by semicolons (;). Alternatively, the subexpressions can be stored in separate strings in the multiple-valued input field.

Each subexpression is of the form:

The <lhs> can be any one of the outputs or a temporary variable. The engine provides 8 temporary floating-point variables (ta, tb, tc, td, te, tf, tg, and th), and 8 temporary vector variables (tA, tB, tC, tD, tE, tF, tG, and tH). You can assign a value to one component of a vector output (A -H ) or a vector variable (tA -tH ) by using the [] operator. For example, oA[0] = <rhs>, will evaluate the right hand side and assign the value to the first component of the output vector oA .

The <rhs> supports arithmetic, logical and conditional operators. They are:

(unary)   !, -
(binary)  +, -, *, /, %, <, > <=, >=, ==, !=, &&, ||
(ternary) ? : 

The ternary operator is a conditional operator. For example, a ? b : c evaluates to b if a != 0, and to c if a==0.

Valid operands for the <rhs> include the inputs, outputs, temporary variables, and their components (e.g. oA[0]). Operands can also be numeric constants (e.g. 1.0), pre-defined named constants, or pre-defined functions.

The named constants are:

MAXFLOAT 
MINFLOAT  
M_E 
M_LOG2E 
M_LOG10E 
M_LN2 
M_LN10 
M_PI 
M_SQRT2  = sqrt(2)
M_SQRT1_2 = sqrt(1/2)

Most of the pre-defined functions come from the math library:

cos, sin, tan, 
acos, asin, atan, atan2, 
cosh, sinh, tanh,
sqrt, pow, exp, log, log10,
ceil, floor, fabs, fmod. 

Other functions are defined by SoCalculator. They are:

rand(f) - Random number generator
cross(v1, v2) - Vector cross product 
dot(v1, v2) - Vector dot product 
length(v) - Vector length
normalize(v) - Normalize vector
vec3f(f1, f2, f3) - Generate a vector from 3 floats

The subexpressions are evaluated in order, so a variable set in the <lhs> of an earlier expression may be used in the <rhs> of a later expression.

Note, when the input has multiple values, all the subexpressions specified in the expression are applied to all the multiple input values. This is unlike the SoBoolOperation engine, where each operation is applied only to the corresponding entries of the input data. Note also, that even though the inputs and outputs can have multiple values the [] operator is only for indexing into the values of a single vector. It does not index into the multiple values of a field. For example, if the floating-point input field a has two values: 1.0, and 2.0, then the expression

"oA[0]=a; oA[1]=a; oA[2]=0.0"

will produce two output vectors in oA : (1.0, 1.0, 0.0) and (2.0, 2.0, 0.0).

Examples of expressions:

"ta = oA[0]*floor(a)"
"tb = (a+b)*sin(M_PI)"
"oA = vec3f(ta, tb, ta+tb)"
"oB = normalize(oA)"
"ta = a; tb = sin(ta); oA = vec3f(ta, tb, 0)"

File Format/Default

: Calculator {

}

See Also

: SoEngineOutput, SoBoolOperation

Definition at line 204 of file SoCalculator.h.

Constructor & Destructor Documentation

◆ SoCalculator()

SoCalculator::SoCalculator ( )

Member Function Documentation

◆ initClass()

static void SoCalculator::initClass ( )

static

◆ inputChanged()

virtual void SoCalculator::inputChanged ( SoField * whichField )

protectedvirtual

The default method does nothing. Subclasses can override this to detect when a specific field is changed.

Reimplemented from SoEngine.

Member Data Documentation

◆ a

SoMFFloat SoCalculator::a

Definition at line 214 of file SoCalculator.h.

◆ A

SoMFVec3f SoCalculator::A

Definition at line 217 of file SoCalculator.h.

◆ b

SoMFFloat SoCalculator::b

Definition at line 214 of file SoCalculator.h.

◆ B

SoMFVec3f SoCalculator::B

Definition at line 217 of file SoCalculator.h.

◆ c

SoMFFloat SoCalculator::c

Definition at line 214 of file SoCalculator.h.

◆ C

SoMFVec3f SoCalculator::C

Definition at line 217 of file SoCalculator.h.

◆ d

SoMFFloat SoCalculator::d

Definition at line 214 of file SoCalculator.h.

◆ D

SoMFVec3f SoCalculator::D

Definition at line 217 of file SoCalculator.h.

◆ e

SoMFFloat SoCalculator::e

Definition at line 214 of file SoCalculator.h.

◆ E

SoMFVec3f SoCalculator::E

Definition at line 217 of file SoCalculator.h.

◆ expression

SoMFString SoCalculator::expression

Definition at line 220 of file SoCalculator.h.

◆ f

SoMFFloat SoCalculator::f

Definition at line 214 of file SoCalculator.h.

◆ F

SoMFVec3f SoCalculator::F

Definition at line 217 of file SoCalculator.h.

◆ g

SoMFFloat SoCalculator::g

Definition at line 214 of file SoCalculator.h.

◆ G

SoMFVec3f SoCalculator::G

Definition at line 217 of file SoCalculator.h.

◆ h

SoMFFloat SoCalculator::h

Definition at line 214 of file SoCalculator.h.

◆ H

SoMFVec3f SoCalculator::H

Definition at line 217 of file SoCalculator.h.

◆ oa

SoEngineOutput SoCalculator::oa

Definition at line 227 of file SoCalculator.h.

◆ oA

SoEngineOutput SoCalculator::oA

Definition at line 229 of file SoCalculator.h.

◆ ob

SoEngineOutput SoCalculator::ob

Definition at line 227 of file SoCalculator.h.

◆ oB

SoEngineOutput SoCalculator::oB

Definition at line 229 of file SoCalculator.h.

◆ oc

SoEngineOutput SoCalculator::oc

Definition at line 227 of file SoCalculator.h.

◆ oC

SoEngineOutput SoCalculator::oC

Definition at line 229 of file SoCalculator.h.

◆ od

SoEngineOutput SoCalculator::od

Definition at line 227 of file SoCalculator.h.

◆ oD

SoEngineOutput SoCalculator::oD

Definition at line 229 of file SoCalculator.h.

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

C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/engines/SoCalculator.h

Public Attributes

Outputs

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoCalculator()

Member Function Documentation

◆ initClass()

◆ inputChanged()

Member Data Documentation

◆ a

◆ A

◆ b

◆ B

◆ c

◆ C

◆ d

◆ D

◆ e

◆ E

◆ expression

◆ f

◆ F

◆ g

◆ G

◆ h

◆ H

◆ oa

◆ oA

◆ ob

◆ oB

◆ oc

◆ oC

◆ od

◆ oD