.TH "SoSFBitMask" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoSFBitMask \- 
.PP
The \fBSoSFBitMask\fP class is a container for a set of bit flags\&.
.PP
This field is used where nodes, engines or other field containers needs to store one particular set of bit flags from an enumerated set\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/fields/SoSFBitMask\&.h>\fP
.PP
Inherits \fBSoSFEnum\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const "
.br
.ti -1c
.RI "virtual void \fBcopyFrom\fP (const \fBSoField\fP &field)"
.br
.ti -1c
.RI "const \fBSoSFBitMask\fP & \fBoperator=\fP (const \fBSoSFBitMask\fP &field)"
.br
.ti -1c
.RI "virtual SbBool \fBisSame\fP (const \fBSoField\fP &field) const "
.br
.ti -1c
.RI "int \fBoperator=\fP (int newvalue)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoSFBitMask\fP class is a container for a set of bit flags\&.
.PP
This field is used where nodes, engines or other field containers needs to store one particular set of bit flags from an enumerated set\&. 

A field of this type stores its value to file as the symbolic names, rather than the actual integer bitmask\&. If more than one bit is set in the value when exporting, the bits are written like this: '(BITNAME|BITNAME|BITNAME|\&.\&.\&.)'\&.
.PP
\fBSoSFBitMask\fP instances are derived from \fBSoSFEnum\fP instances, and are initialized in the same way using the exact same enum-field-related macros\&.
.PP
\fBSee also:\fP
.RS 4
\fBSoMFBitMask\fP, \fBSoSFEnum\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoSFBitMask::getTypeId (void) const\fC [virtual]\fP"
Returns the type identification instance which uniquely identifies the Coin field class the object belongs to\&.
.PP
\fBSee also:\fP
.RS 4
getClassTypeId(), \fBSoType\fP 
.RE
.PP

.PP
Reimplemented from \fBSoSFEnum\fP\&.
.SS "void SoSFBitMask::copyFrom (const \fBSoField\fP &f)\fC [virtual]\fP"
Copy value(s) from \fIf\fP into this field\&. \fIf\fP must be of the same type as this field\&. 
.PP
Reimplemented from \fBSoSFEnum\fP\&.
.SS "SbBool SoSFBitMask::isSame (const \fBSoField\fP &f) const\fC [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Reimplemented from \fBSoSFEnum\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.