Single-value field containing a set of bit flags. More...

#include <Inventor/fields/SoSFBitMask.h>

Inheritance diagram for SoSFBitMask:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

const SoSFBitMask &	operator= (const SoSFBitMask &f)
	Copy from another field of same type.

	SoSFBitMask ()
	Default constructor.

virtual	~SoSFBitMask ()
	Destructor.

int	operator= (int newValue)
	Sets this field to newValue.

Public Member Functions inherited from SoSFEnum
const SoSFEnum &	operator= (const SoSFEnum &f)
	Copy from another field of same type.

	SoSFEnum ()
	Default constructor.

virtual	~SoSFEnum ()
	Destructor.

int	getValue () const
	Returns this field's value.

void	setValue (int newValue)
	Sets this field to newValue.

int	operator= (int newValue)
	Sets this field to newValue.

int	operator== (const SoSFEnum &f) const
	Returns TRUE if otherField is of the same type and has the same value as this field.

int	operator!= (const SoSFEnum &f) const
	Returns FALSE if otherField is of the same type and has the same value as this field.

virtual size_t	getValueSize () const
	Get size of the value.

void	setValue (const SbName &name)
	Sets this field to contain the given mnemonic name, passed in as a name or string.

void	getEnums (int &num, int &vals, SbName &names)
	Gets value/name correspondances.

Public Member Functions inherited from SoField
void	setIgnored (SbBool ig)
	Sets the ignore flag for this field.

SbBool	isIgnored () const
	Gets the ignore flag for this field.

SbBool	isDefault () const
	Gets the state of default flag of the field.

void	enableConnection (SbBool flag)
	Field connections may be enabled and disabled.

SbBool	isConnectionEnabled () const
	Returns FALSE if connections to this field are disabled.

SbBool	connectFrom (SoEngineOutput *engineOutput)
	Connects this field from an engine output.

SbBool	connectFrom (SoField *field)
	Connects this field to another field.

SbBool	connectFrom (SoVRMLInterpOutput *interpOutput)
	Connects this field from an interpOutput.

SbBool	appendConnection (SoEngineOutput *engineOutput)
	Appends this field to the list of connections from another engineOutput.

SbBool	appendConnection (SoField *field)
	Appends this field to the list of connections from another field.

SbBool	appendConnection (SoVRMLInterpOutput *interpOutput)
	Appends this field to the list of connections from another interpOutput.

void	disconnect (SoEngineOutput *engineOutput)
	Disconnect the field from the requested engineOutput.

void	disconnect (SoField *field)
	Disconnect the field from the requested field.

void	disconnect (SoVRMLInterpOutput *interpOutput)
	Disconnect the field from the requested interpOutput.

int	getNumConnections () const
	Returns the number of connections to this field.

int	getConnections (SoFieldList &list)
	Returns a list of the connections to this field.

void	disconnect ()
	Disconnect the field from whatever it was connected to.

SbBool	isConnected () const
	Returns TRUE if the field is connected to anything.

SbBool	isConnectedFromVRMLInterp () const
	Returns TRUE if the field is connected to a VRML interpOutput.

SbBool	isConnectedFromEngine () const
	Returns TRUE if the field is connected to an engine's output.

SbBool	isConnectedFromField () const
	Returns TRUE if the field is connected to another field.

SbBool	getConnectedEngine (SoEngineOutput *&engineOutput) const
	Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.

SbBool	getConnectedField (SoField *&writingField) const
	Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.

SbBool	getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
	Returns the VRMLInterpolator output field is connected to.

int	getForwardConnections (SoFieldList &list) const
	Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.

SoFieldContainer *	getContainer () const
	Returns the object that contains this field.

SoNONUNICODE SbBool	set (const char *valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

SbBool	set (const SbString &valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

void	get (SbString &valueString)
	Returns the value of the field in the Open Inventor file format, even if the field has its default value.

virtual void	touch ()
	Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.

int	operator== (const SoField &f) const
	Return TRUE if this field is of the same type and has the same value as f.

int	operator!= (const SoField &f) const
	Return FALSE if this field is of the same type and has the same value as f.

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 SoSFEnum
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoSField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

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

Detailed Description

Single-value field containing a set of bit flags.

A single-value field that contains a mask of bit flags, stored as an integer. Nodes that use this field class define mnemonic names for the bit flags. These names should be used when setting or testing the values of the field, even though the values are treated as integers in the methods.

The bit-wise "&" and "|" operators should be used when testing and setting flags in a mask. For example:

// Add sides to the set of parts rendered
text3->parts = text3->parts.getValue() | SoText3::SIDES;
 
// Remove sides from the set of parts rendered
text3->parts = text3->parts.getValue() & ~SoText3::SIDES;

SoSFBitMasks are written to file as one or more mnemonic enumerated type names, in this format:

( flag1 | flag2 | ... )

If only one flag is used in a mask, the parentheses are optional. These names differ among uses of this field in various node or engine classes. See their reference pages for the names.

The field values may also be represented as integers, but this is not guaranteed to be portable.

Constructor & Destructor Documentation

◆ SoSFBitMask()

SoSFBitMask::SoSFBitMask ( )

Default constructor.

◆ ~SoSFBitMask()

virtual SoSFBitMask::~SoSFBitMask ( )

virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSFBitMask::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoSFBitMask::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoSFEnum.

◆ operator=() [1/2]

const SoSFBitMask & SoSFBitMask::operator= ( const SoSFBitMask & f )

Copy from another field of same type.

◆ operator=() [2/2]

int SoSFBitMask::operator= ( int newValue )

inline

Sets this field to newValue.

Definition at line 125 of file SoSFBitMask.h.

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

Inventor/fields/SoSFBitMask.h

Open Inventor Release 2024.1.3

Public Member Functions

Static Public Member Functions