The SFString field contains a string. More...
#include <H3D/SFString.h>
Inheritance diagram for H3D::SFString:
Public Member Functions | |
| void | addValidValue (const string &s) |
| Add a valid value for the string. More... | |
| template<class InputIterator > | |
| void | addValidValues (InputIterator begin, InputIterator end) |
| Add valid values for the string. More... | |
| bool | isValidValue (const string &s) |
| Returns true if the given string is one of the specified valid values for the field. | |
| bool | hasValidValues () |
| Returns true if any valid values have been specified for the field. | |
| const set< string > & | getValidValues () |
| Returns the valid values for the field. | |
| void | clearValidValues () |
| Clears the valid values for the field. | |
 Public Member Functions inherited from H3D::SField< string > | |
| SField () | |
| Constructor. | |
| SField (const string &_value) | |
| Constructor. | |
| virtual int | setValueFromVoidPtr (const void *data, unsigned int len, int id=0) |
| Set the value of the field given a pointer to where the value of the field is. More... | |
| virtual int | getValueAsVoidPtr (void *data, unsigned int len, int id=0) |
| Get the value of the data copied into a memory buffer. More... | |
| virtual unsigned int | valueTypeSize () |
| Returns the size in bytes of the value type the sfield encapsulates. | |
| virtual void | setValue (const string &v, int id=0) |
| Set the value of the field. | |
| virtual const string & | getValue (int id=0) |
| Get the value of the field. | |
| virtual void | setValueFromString (const string &s) |
| Set the value of the field given a string. More... | |
| virtual string | getValueAsString (const string &=" ") |
| Get the value of the field as a string. | |
| virtual string | getTypeName () |
| Returns a string name for this field type e.g. SFInt32. | |
| Public Member Functions inherited from H3D::SFieldClass | |
| virtual | ~SFieldClass () |
| Virtual destructor. | |
| virtual int | setValueFromVoidPtr (void *data, unsigned int size, int id=0) |
Additional Inherited Members | |
| Public Types inherited from H3D::SField< string > | |
| typedef string | value_type |
| The type of the value member. | |
| Static Public Member Functions inherited from H3D::SField< string > | |
| static string | classTypeName () |
| Returns a string name for this field type e.g. SFInt32. | |
| Protected Member Functions inherited from H3D::SField< string > | |
| virtual void | update () |
| Make the field up to date given that an event has occured. | |
| Protected Member Functions inherited from H3D::TypedField< BaseField, RequiredArgTypes, OptionalArgTypes > | |
| void | checkFieldType (Field *f, int index) |
| Function for checking that a field is of a correct type given type specification according to the TypedField template arguments. More... | |
| void | checkTemplateArguments () |
| Function for checking that a field given TypedField type specification is valid. More... | |
| Protected Attributes inherited from H3D::SField< string > | |
| string | value |
| The encapsulated value. | |
Detailed Description
The SFString field contains a string.
Member Function Documentation
◆ addValidValue()
|
inline |
Add a valid value for the string.
valid values is a set of values that the field can be set to to make sense. It is not forced to be any of these values but they provide an indication of what values to use.
◆ addValidValues()
template<class InputIterator >
|
inline |
Add valid values for the string.
valid values is a set of values that the field can be set to to make sense. It is not forced to be any of these values but they provide an indication of what values to use.
The documentation for this class was generated from the following file:
