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  -  SOSFIELD (3)

NAME

SoSField — abstract base class for all single-value fields

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoField > SoSField

SYNOPSIS

#include <Inventor/fields/SoField.h>

Methods from class SoSField:

    static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoField:

    void    
                    
void                 setIgnored(SbBool ignore)    
SbBool    
                    
SbBool               isIgnored() const    
SbBool    
                    
SbBool               isDefault() const    
virtual SoType    
                    
virtual SoType       getTypeId() const    
virtual SbBool    
                    
virtual SbBool       isOfType(SoType type) const    
SbBool    
                    
SbBool               set(const char *valueString)    
void    
                    
void                 get(SbString &valueString)    
int    
                    
int                  operator ==(const SoField &f) const    
int    
                    
int                  operator !=(const SoField &f) const    
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

Each class derived from SoSField begins with an SoSF prefix and contains one value of a particular type. Each has setValue() and getValue() methods that are used to change or access this value. In addition, some field classes have extra convenience routines that allow values to be set or retrieved in other related formats (see below).

In addition to setValue(), all single-value fields overload the "=" assignment operator to set the field value from the correct datatype or from another field instance of the same type.

The value of a single-value field is written to file in a format dependent on the field type; see the subclass man pages for details.

A field that is ignored has a tilde (~) either in place of the value (if the actual value is the default) or after it (otherwise).

METHODS

    static SoType    
                    
static SoType        getClassTypeId()
Return the type identifier for this field class.

SEE ALSO

SoField, SoMField

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


SOSFIELD(3IV) (-->)

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