int x3d::CompareName ( const char * n1,

const char * n2

)

Compare two field names.
This function compares two fields names. The problem is that some names in XML may include a colon (:), a dash (-) or period (.) and all of these will be converted to an underscore (_) before comparison.

Parameters:

n1 a pointer to a null terminated utf-8 string

n2 a pointer to a null terminated utf-8 string

Returns:
The function returns 0 when n1 equals n2, -1 when n1 is before n2 and +1 when n1 is after n2

SFNode* x3d::CreateNode ( field_t type )

SFNode* x3d::CreateUserNode ( field_t type )

char x3d::FixNameChar ( char c ) [inline]

LevelOfSupport * x3d::GetBaseSupport ( )

The support levels offered by the X3D base library.
This function can be used to get the LevelOfSupport object implemented by the X3D base library to know what level of support the nodes offer.

See also:
LevelOfSupport

field_t x3d::GetField ( const char * name )

const char* x3d::GetName ( field_t id )

field_t x3d::GetType ( const char * name )

field_t x3d::GetUserField ( const char * name )

const char* x3d::GetUserName ( field_t id )

field_t x3d::GetUserType ( const char * name )

void x3d::MValueToString ( const MFString & value,

SFString & str

)

Convert an array of strings to a single string.
This function takes an array of strings and it transforms it to one long string.
The input string is replaced with the result.

Note:
The strings in the array will be escaped before to be saved in the output string as expected (see the XML encoding specification in the X3D documentation)

Parameters:

[in] value the array of string to convert

[out] str the string where the result is saved

See also:
bool StringToMValue(MFString& value, const char *& str);

template<class MF>

void x3d::MValueToString ( const MF & value,

SFString & str

)

static const Type* x3d::Register ( Types & t,

const char * type,

UserType * user_type,

field_t & next_id,

bool record

) [static]

void x3d::RegisterType ( field_t type,

Instantiator * instantiator

)

field_t x3d::RegisterUserName ( const char * name )

Register a new user name to use with the currently running application.
The RegisterUserName() function can be used to register a new field name. Whenever you register a new user type and that type has its own private fields, these fields need to be declared to the system. This is done with a call to this function.
If a field of that name already exists, the same identifier will be returned. It is legal to re-use the same name multiple times, however, a class cannot overload a field. The field in the super class would otherwise be improperly shadowed.

Parameters:

name the name of the new field

Returns:
The function returns the new field identification.

field_t x3d::RegisterUserType ( const char * name,

UserType * user_type

)

Register a new type to use with the currently running application.
The RegisterUserType() function can be used to register an additional type not defined in the X3D specification. This is a way to enlarge the dataset.
You cannot register two types with the same name. If name is already a registered type, then that type identification will be returned.

Parameters:

name the textual name of the type in a utf-8 string

user_type a class defining the user type (see UserType)

Returns:
The function returns the newly registered type or the already existing type. To know whether a type already exists, use the GetType() function first, if it returns FLD_UNKNOWN, then it does not exist yet.

static void x3d::SkipSpaces ( const char *& str ) [static]

bool x3d::StringToMValue ( MFString & value,

const char *& str

)

Convert a string to an array of strings.
This function takes a string with a set of strings defined between double quotes and converts them to an array of strings.
The input string is not modified, but the pointer will be positioned past all of the quoted strings (it is actually expected to be the end of the input string.) Note that it is still considered valid if the input does not contain a string and the end of the input string was not reached.

Note:
The input strings are automatically unescaped as expected (see the XML encoding specification in the X3D documentation)

Parameters:

[out] value the array where to save the result; if no quoted strings are found in the input string, then it will be empty

[in,out] str the string where the quoted strings are read; it is incremented past all the quoted strings on exit; it is expected to be the end of the input string

Returns:
The function returns true if a valid array of string is read, false otherwise.

See also:
void MValueToString(const MFString& value, SFString& str)

template<class MF>

bool x3d::StringToMValue ( MF & value,

const char *& str

)

bool x3d::StringToValue ( SFVec3f & value,

const char *& str

)

Convert a string to a 3 dimension vector structure of floats.
This function takes a string with a set of three textual floating point values and converts them to a SFVec3f structure.
The input string is not modified, but the pointer will be positioned past the two floating point values.

Parameters:

[out] value the variable where to save the result; set the components to 0.0 if the input string is invalid

[in,out] str the string where the floating point values are to be read; it is incremented past the values on exit

Returns:
The function returns true if a valid SFVec3f value is read, false otherwise.

See also:
void ValueToString(const SFVec3f& value, SFString& str);

bool x3d::StringToValue ( SFVec3d & value,

const char *& str

)

Convert a string to a 3 dimension vector structure of doubles.
This function takes a string with a set of three textual floating point values and converts them to a SFVec3d structure.
The input string is not modified, but the pointer will be positioned past the two floating point values.

Parameters:

[out] value the variable where to save the result; set the components to 0.0 if the input string is invalid

[in,out] str the string where the floating point values are to be read; it is incremented past the values on exit

Returns:
The function returns true if a valid SFVec3d value is read, false otherwise.

See also:
void ValueToString(const SFVec3d& value, SFString& str);

bool x3d::StringToValue ( SFVec2f & value,

const char *& str

)

Convert a string to a 2 dimension vector structure of floats.
This function takes a string with a set of two textual floating point values and converts them to a SFVec2f structure.
The input string is not modified, but the pointer will be positioned past the two floating point values.

Parameters:

[out] value the variable where to save the result; set the components to 0.0f if the input string is invalid

[in,out] str the string where the floating point values are to be read; it is incremented past the values on exit

Returns:
The function returns true if a valid SFVec2f value is read, false otherwise.

See also:
void ValueToString(const SFVec2f& value, SFString& str);

bool x3d::StringToValue ( SFVec2d & value,

const char *& str

)

Convert a string to a 2 dimension vector structure of doubles.
This function takes a string with a set of two textual floating point values and converts them to a SFVec2d structure.
The input string is not modified, but the pointer will be positioned past the two floating point values.

Parameters:

[out] value the variable where to save the result; set the components to 0.0 if the input string is invalid

[in,out] str the string where the floating point values are to be read; it is incremented past the values on exit

Returns:
The function returns true if a valid SFVec2d value is read, false otherwise.

See also:
void ValueToString(const SFVec2d& value, SFString& str);

bool x3d::StringToValue ( SFRotation & value,

const char *& str

)

Convert a string to a rotation structure.
This function takes a string with a set of four textual floating point values and converts them to a rotation structure.
The input string is not modified, but the pointer will be positioned past the four floating point values.

Parameters:

[out] value the variable where to save the result; set the components to 0.0f (x, y and angle) or 1.0f (z) if the input string is invalid

[in,out] str the string where the floating point values are to be read; it is incremented past the values on exit

Returns:
The function returns true if a valid rotation value is read, false otherwise.

See also:
void ValueToString(const SFRotation& value, SFString& str);

bool x3d::StringToValue ( SFInt32 & value,

const char *& str

)

Convert a string to an integer value.
This function takes a string with a textual integer value and converts it to an integer value.
The input string is not modified, but the pointer will be positioned past the floating point value.

Parameters:

[out] value the variable where to save the result; set to 0.0f if the input string is invalid

[in,out] str the string where the floating point value is to be read; it is incremented past the value on exit

Returns:
The function returns true if a valid integer value is read, false otherwise.

See also:
void ValueToString(SFInt32 value, SFString& str);

bool x3d::StringToValue ( SFImage & value,

const char *& str

)

Convert a string to an image.
This function takes a string with a set of textual integers and converts them to an image. An image is expected to be composed of at least three integers (width height components) followed by width x height pixels (if components is not zero). All the values can be defined in decimal or hexadecimal.
The input string is not modified, but the pointer will be positioned past the image integers.

Parameters:

[out] value the variable where to save the result; set to 0.0f if the input string is invalid

[in,out] str the string where the floating point value is to be read; it is incremented past the value on exit

Returns:
The function returns true if a valid double value is read, false otherwise.

See also:
void ValueToString(const SFImage& value, SFString& str);

bool x3d::StringToValue ( SFFloat & value,

const char *& str

)

Convert a string to a float value.
This function takes a string with a textual floating point value and converts it to a float value.
The input string is not modified, but the pointer will be positioned past the floating point value.

Parameters:

[out] value the variable where to save the result; set to 0.0f if the input string is invalid

[in,out] str the string where the floating point value is to be read; it is incremented past the value on exit

Returns:
The function returns true if a valid double value is read, false otherwise.

See also:
void ValueToString(SFFloat value, SFString& str);

bool x3d::StringToValue ( SFDouble & value,

const char *& str

)

Convert a string to a double value.
This function takes a string with a textual floating point value and converts it to a double value.
The input string is not modified, but the pointer will be positioned past the floating point value.

Attention:
There is no StringToValue(SFTime& value, const char *& str) because the types of SFTime and SFDouble are the same. In other words, whenever you try to convert a time, it will indeed use the corresponding double functions.

Parameters:

[out] value the variable where to save the result; set to 0.0 if the input string is invalid

[in,out] str the string where the floating point value is to be read; it is incremented past the value on exit

Returns:
The function returns true if a valid double value is read, false otherwise.

See also:
void ValueToString(SFDouble value, SFString& str);

bool x3d::StringToValue ( SFColorRGBA & value,

const char *& str

)

Convert a string to a color with alpha structure.
This function takes a string with a set of four textual floating point values between 0.0f and 1.0f and converts them to an RGB color and an alpha channel.
The input string is not modified, but the pointer will be positioned past the four components value.

Parameters:

[out] value the variable where to save the result; set to fully transparent black if the input string is invalid

[in,out] str the string where the color components are to be read; it is incremented past the components on exit

Returns:
The function returns true if a valid RGBA color value is read, false otherwise.

Todo:
Should we clamp the values?

See also:
void ValueToString(const SFColorRGBA& value, SFString& str);

bool x3d::StringToValue ( SFColor & value,

const char *& str

)

Convert a string to a color structure.
This function takes a string with a set of three textual floating point values between 0.0f and 1.0f and converts them to an RGB color.
The input string is not modified, but the pointer will be positioned past the three components value.

Parameters:

[out] value the variable where to save the result; set to black if the input string is invalid

[in,out] str the string where the color components are to be read; it is incremented past the components on exit

Returns:
The function returns true if a valid color value is read, false otherwise.

Todo:
Should we clamp the values?

See also:
void ValueToString(const SFColor& value, SFString& str);

bool x3d::StringToValue ( SFBool & value,

const char *& str

)

Convert a string to a boolean value.
This function takes a string with a boolean value of "true" or "false" and converts it to a boolean value.
The input string is not modified, but the pointer will be positioned past the boolean value.

Parameters:

[out] value the variable where to save the result; set to false if the input string is invalid

[in,out] str the string where the boolean value is to be read; it is incremented past the value on exit

Returns:
The function returns true if a valid boolean value is read, false otherwise.

See also:
void ValueToString(SFBool value, SFString& str);

void x3d::ValueToString ( const SFVec3f & value,

SFString & str

)

Convert a 3 dimensional vector structure into a string.
This function takes an SFVec3f structure and converts it to three textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the SFVec3f structure to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFVec3f& value, const char *& str);

void x3d::ValueToString ( const SFVec3d & value,

SFString & str

)

Convert a 3 dimensional vector structure into a string.
This function takes an SFVec3d structure and converts it to three textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the SFVec3d structure to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFVec3d& value, const char *& str);

void x3d::ValueToString ( const SFVec2f & value,

SFString & str

)

Convert a 2 dimensional vector structure into a string.
This function takes an SFVec2f structure and converts it to two textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the SFVec2f structure to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFVec2f& value, const char *& str);

void x3d::ValueToString ( const SFVec2d & value,

SFString & str

)

Convert a 2 dimensional vector structure into a string.
This function takes an SFVec2d structure and converts it to two textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the SFVec2d structure to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFVec2d& value, const char *& str);

void x3d::ValueToString ( const SFRotation & value,

SFString & str

)

Convert a rotation structure into a string.
This function takes a rotation structure and converts it to four textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the rotation structure to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFRotation& value, const char *& str);

void x3d::ValueToString ( SFInt32 value,

SFString & str

)

Convert a 32 bits integer value into a string.
This function takes an integer value and converts it to a textual integer string.
The input string is replaced with the result.

Parameters:

[in] value the integer value to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFInt32& value, const char *& str);

void x3d::ValueToString ( const SFImage & value,

SFString & str

)

Convert an image to a string.
This function takes an image and converts it to a string.
The result is a string with at least three integers (width height components). These three integers will be followed by width x height integers (if components is not zero). This function converts all the values in decimal numbers since it uses less space than hexadecimal.
The input string is replaced with the result.

Parameters:

[in] value the image to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFImage& value, const char *& str);

void x3d::ValueToString ( SFFloat value,

SFString & str

)

Convert a float value into a string.
This function takes a float value and converts it to a textual floating point string.
The input string is replaced with the result.

Parameters:

[in] value the RGBA color value to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFFloat& value, const char *& str);

void x3d::ValueToString ( SFDouble value,

SFString & str

)

Convert a double value into a string.
This function takes a double and converts it to a textual floating point string.
The input string is replaced with the result.

Attention:
There is no ValueToString(SFTime value, SFString& str) because the types of SFTime and SFDouble are the same. In other words, whenever you try to convert a time, it will indeed use the corresponding double functions.

Parameters:

[in] value the double to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFDouble& value, const char *& str);

void x3d::ValueToString ( const SFColorRGBA & value,

SFString & str

)

Convert an RGBA color value into a string.
This function takes a four component RGBA color value and converts it to four textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the RGBA color value to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFColorRGBA& value, const char *& str);

void x3d::ValueToString ( const SFColor & value,

SFString & str

)

Convert an RGB color value into a string.
This function takes a three component RGB color value and converts it to three textual floating points in a string.
The input string is replaced with the result.

Parameters:

[in] value the RGB color value to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFColor& value, const char *& str);

void x3d::ValueToString ( SFBool value,

SFString & str

)

Convert a boolean value into a string.
This function takes a boolean value and converts it to a textual boolean in a string.
The input string is replaced with the result.

Parameters:

[in] value the boolean value to convert to a string

[out] str the string where the result is saved

See also:
void StringToValue(SFBool& value, const char *& str);

bool x3d::ValueToString ( const FieldInfo * info,

SFString & str

)

Convert a value into a string.
This function takes an initialized FieldInfo structure and converts it to a textual string.
The input field info can represent any type including user types.
The input string is replaced with the result.

Todo:
The MFImage is not implemented (not required by the X3D specification and probably not useful); try to use this type will result in an assert() in debug mode and it will always return false in release.

Parameters:

[in] info a valid FieldInfo structure; i.e. returned by a GetFieldByName()

[out] str the string where the result is saved

See also:
field_t SFNode::SetFieldByName(const char *name, const char *value);