GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOSFSTRING (3)

NAME

SoSFString — field containing a string

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoField > SoSField > SoSFString

SYNOPSIS

#include <Inventor/fields/SoSFString.h>

Methods from class SoSFString:

       
                    
                     setValue(const char *string)    
static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const    
const SbString &    
                    
const SbString &     getValue() const    
const SbString &    
                    
const SbString &     operator =(const SbString & newValue)    
void    
                    
void                 setValue(const SbString & newValue)    
int    
                    
int                  operator ==(const SoSFString &f) const    
int    
                    
int                  operator !=(const SoSFString &f) const

Methods from class SoField:

    void    
                    
void                 setIgnored(SbBool ignore)    
SbBool    
                    
SbBool               isIgnored() const    
SbBool    
                    
SbBool               isDefault() const    
virtual SbBool    
                    
virtual SbBool       isOfType(SoType type) const    
SbBool    
                    
SbBool               set(const char *valueString)    
void    
                    
void                 get(SbString &valueString)    
void    
                    
void                 touch()    
SbBool    
                    
SbBool               connectFrom(SoField *fromField)    
SbBool    
                    
SbBool               connectFrom(SoEngineOutput *fromEngine)    
void    
                    
void                 disconnect()    
SbBool    
                    
SbBool               isConnected() const    
SbBool    
                    
SbBool               isConnectedFromField() const    
SbBool    
                    
SbBool               getConnectedField(SoField *&writingField) const    
SbBool    
                    
SbBool               isConnectedFromEngine() const    
SbBool    
                    
SbBool               getConnectedEngine(SoEngineOutput *&engineOutput) const    
void    
                    
void                 enableConnection(SbBool flag)    
SbBool    
                    
SbBool               isConnectionEnabled() const    
int    
                    
int                  getForwardConnections(SoFieldList &list) const    
SoFieldContainer *    
                    
SoFieldContainer *   getContainer() const

DESCRIPTION

A field containing an ASCII string (sequence of characters). Inventor does not support non-ASCII strings.

SoSFStrings are written to file as a sequence of ASCII characters in double quotes (optional if the string doesn’t contain any whitespace). Any characters (including newlines) may appear within the quotes. To include a double quote character within the string, precede it with a backslash. For example:



Testing "One, Two, Three" "He said, \"Immel did it!\""

are all valid strings.

METHODS

       
                    
                     setValue(const char *string)
Convenience method to set the field’s value given a character array.

    static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const
Returns the type for this class or a particular object of this class.

    const SbString &    
                    
const SbString &     getValue() const
Returns this field’s value.

    const SbString &    
                    
const SbString &     operator =(const SbString & newValue)    
void    
                    
void                 setValue(const SbString & newValue)
Sets this field to newValue.

    int    
                    
int                  operator ==(const SoSFString &f) const    
int    
                    
int                  operator !=(const SoSFString &f) const
Returns TRUE if f is of the same type and has the same value as this field.

SEE ALSO

SbString, SoField, SoSField, SoMFString

Search for    or go to Top of page |  Section 3 |  Main Index


SOSFSTRING(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.