Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoBoolOperation Class Reference

Performs Boolean operations. More...

#include <Inventor/engines/SoBoolOperation.h>

+ Inheritance diagram for SoBoolOperation:

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
}
 Operation. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoBoolOperation ()
 Constructor.
 
- Public Member Functions inherited from SoEngine
virtual int getOutputs (SoEngineOutputList &list) const
 Returns a list of outputs in this engine.
 
SoEngineOutputgetOutput (const SbName &outputName) const
 Returns a reference to the engine output with the given name.
 
SbBool getOutputName (const SoEngineOutput *output, SbName &outputName) const
 Returns (in outputName) the name of the engine output (output).
 
SoEnginecopy () const
 Creates and returns an exact copy of the engine.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool 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 Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoEngine
static SoType getClassTypeId ()
 Returns the type identifier for the SoEngine class.
 
static SoEnginegetByName (const SbName &name)
 Looks up engine(s) by name.
 
static int getByName (const SbName &name, SoEngineList &list)
 Looks up engine(s) by name.
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoMFBool a
 First argument to the Boolean operation.
 
SoMFBool b
 Second argument to the Boolean operation.
 
SoMFEnum operation
 The Boolean operation.
 
SoEngineOutput output
 ( SoMFBool ) Result of the Boolean operation applied to the inputs.
 
SoEngineOutput inverse
 ( SoMFBool ) Inverse of output.
 

Detailed Description

Performs Boolean operations.

This engine performs a Boolean operation on two inputs, and returns both the result of the operation and its inverse.

The input fields can have multiple values, allowing the engine to perform several Boolean operations in parallel. One input may have more values than the other. In that case, the last value of the shorter input will be repeated as necessary.

FILE FORMAT/DEFAULT

    BoolOperation {
    a FALSE
    b FALSE
    operation A
    }

SEE ALSO

SoEngineOutput, SoCalculator

Definition at line 85 of file SoBoolOperation.h.

Member Enumeration Documentation

◆ Operation

Operation.

Enumerator
CLEAR 

Clear.

SET 

Set.

A.

NOT_A 

Not A.

B.

NOT_B 

Not B.

A_OR_B 

A or B.

NOT_A_OR_B 

Not A or B.

A_OR_NOT_B 

A or not B.

NOT_A_OR_NOT_B 

Not A or not B.

A_AND_B 

A and B.

NOT_A_AND_B 

Not A and B.

A_AND_NOT_B 

A and not B.

NOT_A_AND_NOT_B 

Not A and not B.

A_EQUALS_B 

A equals B.

A_NOT_EQUALS_B 

A not equals B.

Definition at line 92 of file SoBoolOperation.h.

Constructor & Destructor Documentation

◆ SoBoolOperation()

SoBoolOperation::SoBoolOperation ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoBoolOperation::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoBoolOperation::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Member Data Documentation

◆ a

SoMFBool SoBoolOperation::a

First argument to the Boolean operation.

Definition at line 130 of file SoBoolOperation.h.

◆ b

SoMFBool SoBoolOperation::b

Second argument to the Boolean operation.

Definition at line 134 of file SoBoolOperation.h.

◆ inverse

SoEngineOutput SoBoolOperation::inverse

( SoMFBool ) Inverse of output.

Definition at line 147 of file SoBoolOperation.h.

◆ operation

SoMFEnum SoBoolOperation::operation

The Boolean operation.

Definition at line 138 of file SoBoolOperation.h.

◆ output

SoEngineOutput SoBoolOperation::output

( SoMFBool ) Result of the Boolean operation applied to the inputs.

Definition at line 143 of file SoBoolOperation.h.


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