Field containing a name. More...
#include <Inventor/fields/SoSFName.h>
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
const SoSFName & | operator= (const SoSFName &f) |
Copy from another field of same type. | |
SoSFName () | |
Default constructor. | |
virtual | ~SoSFName () |
Destructor. | |
const SbName & | getValue () const |
Returns this field's value. | |
void | setValue (const SbName &newValue) |
Sets this field to newValue. | |
const SbName & | operator= (const SbName &newValue) |
Sets this field to newValue. | |
int | operator== (const SoSFName &f) const |
Returns TRUE if otherField is of the same type and has the same value as this field. | |
int | operator!= (const SoSFName &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 char *string) |
Sets this field to the name equivalent to the given string. | |
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 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. | |
Field containing a name.
A field containing a name. Names are short series of characters generally used for labels or names, and are stored in a special table designed to allow fast lookup and comparison. For most purposes, an SoSFString field is probably more appropriate.
SoSFNames are written to file as a string of characters. Names must begin with an underscore or alphabetic character, and must consist entirely of underscores, alphabetic characters, or numbers.
Definition at line 84 of file SoSFName.h.
SoSFName::SoSFName | ( | ) |
Default constructor.
|
virtual |
Destructor.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
|
inline |
Returns this field's value.
Definition at line 87 of file SoSFName.h.
|
inlinevirtual |
|
inline |
Returns FALSE if otherField is of the same type and has the same value as this field.
Definition at line 87 of file SoSFName.h.
Sets this field to newValue.
Definition at line 87 of file SoSFName.h.
int SoSFName::operator== | ( | const SoSFName & | f | ) | const |
Returns TRUE if otherField is of the same type and has the same value as this field.
void SoSFName::setValue | ( | const char * | string | ) |
Sets this field to the name equivalent to the given string.
void SoSFName::setValue | ( | const SbName & | newValue | ) |
Sets this field to newValue.