Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::StringConverter Class Reference

Class for converting the core Ogre data types to/from Strings. More...

#include <OgreStringConverter.h>

List of all members.

Static Public Methods

String toString (Real val)
 Converts a Real to a String. More...

String toString (int val)
 Converts an int to a String. More...

String toString (unsigned int val)
 Converts an int to a String. More...

String toString (long val)
 Converts a long to a String. More...

String toString (unsigned long val)
 Converts a long to a String. More...

String toString (bool val)
 Converts a boolean to a String. More...

String toString (const Vector3 &val)
 Converts a Vector3 to a String. More...

String toString (const Matrix3 &val)
 Converts a Matrix3 to a String. More...

String toString (const Matrix4 &val)
 Converts a Matrix4 to a String. More...

String toString (const Quaternion &val)
 Converts a Quaternion to a String. More...

String toString (const ColourValue &val)
 Converts a ColourValue to a String. More...

Real parseReal (const String &val)
 Converts a String to a Real. More...

int parseInt (const String &val)
 Converts a String to a whole number. More...

unsigned int parseUnsignedInt (const String &val)
 Converts a String to a whole number. More...

long parseLong (const String &val)
 Converts a String to a whole number. More...

unsigned long parseUnsignedLong (const String &val)
 Converts a String to a whole number. More...

bool parseBool (const String &val)
 Converts a String to a boolean. More...

Vector3 parseVector3 (const String &val)
 Parses a Vector3 out of a String. More...

Matrix3 parseMatrix3 (const String &val)
 Parses a Matrix3 out of a String. More...

Matrix4 parseMatrix4 (const String &val)
 Parses a Matrix4 out of a String. More...

Quaternion parseQuaternion (const String &val)
 Parses a Quaternion out of a String. More...

ColourValue parseColourValue (const String &val)
 Parses a ColourValue out of a String. More...


Detailed Description

Class for converting the core Ogre data types to/from Strings.

Remarks:
The code for converting values to and from strings is here as a separate class to avoid coupling String to other datatypes (and vice-versa) which reduces compilation dependency: important given how often the core types are used.

This class is mainly used for parsing settings in text files. External applications can also use it to interface with classes which use the StringInterface template class.

The String formats of each of the major types is listed with the methods. The basic types like int and Real just use the underlying C runtime library atof and atoi family methods, however custom types like Vector3, ColourValue and Matrix4 are also supported by this class using custom formats.

Author:
Steve Streeting


Member Function Documentation

bool Ogre::StringConverter::parseBool const String   val [static]
 

Converts a String to a boolean.

Remarks:
Accepts 'true' or 'false' as input.

ColourValue Ogre::StringConverter::parseColourValue const String   val [static]
 

Parses a ColourValue out of a String.

Remarks:
Format is "r g b a" (i.e. 4x Real values, space delimited), or "r g b" which implies an alpha value of 1.0 (opaque). Failure to parse returns ColourValue::Black.

int Ogre::StringConverter::parseInt const String   val [static]
 

Converts a String to a whole number.

Returns:
0.0 if the value could not be parsed, otherwise the numeric version of the String.

long Ogre::StringConverter::parseLong const String   val [static]
 

Converts a String to a whole number.

Returns:
0.0 if the value could not be parsed, otherwise the numeric version of the String.

Matrix3 Ogre::StringConverter::parseMatrix3 const String   val [static]
 

Parses a Matrix3 out of a String.

Remarks:
Format is "00 01 02 10 11 12 20 21 22" where '01' means row 0 column 1 etc. Failure to parse returns Matrix3::IDENTITY.

Matrix4 Ogre::StringConverter::parseMatrix4 const String   val [static]
 

Parses a Matrix4 out of a String.

Remarks:
Format is "00 01 02 03 10 11 12 13 20 21 22 23 30 31 32 33" where '01' means row 0 column 1 etc. Failure to parse returns Matrix4::IDENTITY.

Quaternion Ogre::StringConverter::parseQuaternion const String   val [static]
 

Parses a Quaternion out of a String.

Remarks:
Format is "x y z w" (i.e. 4x Real values, space delimited). Failure to parse returns Quaternion::IDENTITY.

Real Ogre::StringConverter::parseReal const String   val [static]
 

Converts a String to a Real.

Returns:
0.0 if the value could not be parsed, otherwise the Real version of the String.

unsigned int Ogre::StringConverter::parseUnsignedInt const String   val [static]
 

Converts a String to a whole number.

Returns:
0.0 if the value could not be parsed, otherwise the numeric version of the String.

unsigned long Ogre::StringConverter::parseUnsignedLong const String   val [static]
 

Converts a String to a whole number.

Returns:
0.0 if the value could not be parsed, otherwise the numeric version of the String.

Vector3 Ogre::StringConverter::parseVector3 const String   val [static]
 

Parses a Vector3 out of a String.

Remarks:
Format is "x y z" ie. 3 Real components, space delimited. Failure to parse returns Vector3::ZERO.

String Ogre::StringConverter::toString const ColourValue   val [static]
 

Converts a ColourValue to a String.

Remarks:
Format is "r g b a" (i.e. 4x Real values, space delimited).

String Ogre::StringConverter::toString const Quaternion   val [static]
 

Converts a Quaternion to a String.

Remarks:
Format is "x y z w" (i.e. 4x Real values, space delimited)

String Ogre::StringConverter::toString const Matrix4   val [static]
 

Converts a Matrix4 to a String.

Remarks:
Format is "00 01 02 03 10 11 12 13 20 21 22 23 30 31 32 33" where '01' means row 0 column 1 etc.

String Ogre::StringConverter::toString const Matrix3   val [static]
 

Converts a Matrix3 to a String.

Remarks:
Format is "00 01 02 10 11 12 20 21 22" where '01' means row 0 column 1 etc.

String Ogre::StringConverter::toString const Vector3   val [static]
 

Converts a Vector3 to a String.

Remarks:
Format is "x y z" (i.e. 3x Real values, space delimited)

String Ogre::StringConverter::toString bool    val [static]
 

Converts a boolean to a String.

String Ogre::StringConverter::toString unsigned long    val [static]
 

Converts a long to a String.

String Ogre::StringConverter::toString long    val [static]
 

Converts a long to a String.

String Ogre::StringConverter::toString unsigned int    val [static]
 

Converts an int to a String.

String Ogre::StringConverter::toString int    val [static]
 

Converts an int to a String.

String Ogre::StringConverter::toString Real    val [static]
 

Converts a Real to a String.

Trivial format, full precision.

Copyright © 2002 by The OGRE Team