SoBoolOperation(3)

NAME
SoBoolOperation - The SoBoolOperation engine evaluates expressions of boolean logic.

The multivalue fields SoBoolOperation::a and SoBoolOperation::b are combined according to the operations set in SoBoolOperation::operation, with the resulting TRUE or FALSE value set on SoBoolOperation::output.

SYNOPSIS

#include <Inventor/engines/SoBoolOperation.h>

Inherits SoEngine.

  Public Types
enum Operation { CLEAR, SET, A, NOT_A, B, NOT_B, A_OR_B, NOT_A_OR_B, A_OR_NOT_B, NOT_A_OR_NOT_B, A_AND_B, NOT_A_AND_B, A_AND_NOT_B, NOT_A_AND_NOT_B, A_EQUALS_B, A_NOT_EQUALS_B }

  Public Member Functions
virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const
SoBoolOperation ()

  Static Public Member Functions
static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass ()

  Public Attributes
SoMFBool a
SoMFBool b
SoMFEnum operation
SoEngineOutput output
SoEngineOutput inverse

  Protected Member Functions
virtual ~SoBoolOperation (void)

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

  Additional Inherited Members

Detailed Description

The SoBoolOperation engine evaluates expressions of boolean logic.

The multivalue fields SoBoolOperation::a and SoBoolOperation::b are combined according to the operations set in SoBoolOperation::operation, with the resulting TRUE or FALSE value set on SoBoolOperation::output.

Member Enumeration Documentation

  enum SoBoolOperation::Operation
Enumeration of available boolean logic operators.

Enumerator

CLEAR
    Always set SoBoolOperation::output to FALSE, no matter the input values.

SET Always set SoBoolOperation::output to TRUE, no matter the input values.

A   Output result = SoBoolOperation::a

NOT_A
    Output result = ! SoBoolOperation::a

B   Output result = SoBoolOperation::b

NOT_B
    Output result = ! SoBoolOperation::b

A_OR_B
    r = a || b

NOT_A_OR_B
    r = !a || b

A_OR_NOT_B
    r = a || !b

NOT_A_OR_NOT_B
    r = !a || !b

A_AND_B
    r = a && b

NOT_A_AND_B
    r = !a && b

A_AND_NOT_B
    r = a && !b

NOT_A_AND_NOT_B
    r = !a && !b

A_EQUALS_B
    r = a==b

A_NOT_EQUALS_B
    r = ! a==b

Constructor & Destructor Documentation

  SoBoolOperation::SoBoolOperation (void)
Default constructor.

  SoBoolOperation::~SoBoolOperation (void) [protected], [virtual]
Destructor.

Member Function Documentation

  SoType SoBoolOperation::getTypeId (void) const [virtual]
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

  const SoFieldData * SoBoolOperation::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.

Reimplemented from SoFieldContainer.

  const SoEngineOutputData * SoBoolOperation::getOutputData (void) const [virtual]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoEngine.

Member Data Documentation

  SoMFBool SoBoolOperation::a
First set of boolean input 'signal' values.

  SoMFBool SoBoolOperation::b
Second set of boolean input 'signal' values.

  SoMFEnum SoBoolOperation::operation
Set of boolean logic expressions. Each of these are used to combine SoBoolOperation::a with SoBoolOperation::b (for each index value from 0 to the last value) to produce the results on the SoBoolOperation::output field.

  SoEngineOutput SoBoolOperation::output
(SoMFBool) The result of each (a[i] operation[i] b[i]) expression.

  SoEngineOutput SoBoolOperation::inverse
(SoMFBool) The set of inverse results.

Author

Generated automatically by Doxygen for Coin from the source code.