vrml.fieldtypes

Definitions of the standard VRML97 field-types
These are all of the "low-level" field-types (i.e. not nodes) defined by VRML97. Each has a canonical in-memory storage format so that code can rely on that format when dealing with the field values.
We use Numeric Python arrays whereever possible.

Functions

_collapse( inlist , isinstance = <built-in function isinstance> , ltype = <type 'list'> , maxint = 9223372036854775807 )
Destructively flatten a list hierarchy to a single level. Non-recursive, and (as far as I can see, doesn't have any glaring loopholes). Further speedups and obfuscations by Tim Peters :)
_linvalues( lineariser )
Get the linearisation values for a lineariser
collapse( inlist )
As _collapse, but works on a copy of the inlist
MFSimple_vrmlstr( value , lineariser = None )
Convert value to a VRML97 representation
MFString_vrmlstr( value , lineariser = None )
Convert the given value to a VRML97 representation
SFFloat_vrmlstr( value , lineariser = None )
Convert floats to (compact) VRML97 representation
SFString_vrmlstr( value , lineariser = None )
Convert the given value to a VRML97 representation

Classes

class _Color( object ):
Mix-in for colour-value clamping and string coercion
coerce( self , value )
Adds clipping of values to 0.0 through 1.0 range
copyValue( self , value , copier = None )
Copy a value for copier
class _MFColor( _Color_MFVec3f ):
MFColor field/event type base-class
coerce( self , value )
Adds string coercion for color data types
class _MFFloat( object ):
MFFloat field/event type base-class
Stored as a flat Numeric-python array
coerce( self , value )
Base coercion mechanism for floating point field types
copyValue( self , value , copier = None )
Copy a value for copier
vrmlstr( value , lineariser = None )
Convert value to a VRML97 representation
class _MFFloat32( _MFFloat ):
32-BIT floating-point type
class _MFInt32( object ):
MFInt32 field/event type base-class
Stored as a flat Numeric-python array
coerce( self , value )
Base coercion mechanism for multiple-value integer fields
copyValue( self , value , copier = None )
Copy a value for copier
vrmlstr( value , lineariser = None )
Convert value to a VRML97 representation
class _MFMatrix3d( _MFVec ):
3x3 matrix-set field/event type base-class
class _MFMatrix3f( _MFVec32 ):
3x3 matrix-set field/event type base-class
class _MFMatrix4d( _MFVec ):
4x4 matrix-set field/event type base-class
class _MFMatrix4f( _MFVec32 ):
4x4 matrix-set field/event type base-class
class _MFRotation( _MFVec ):
MFRotation field/event type base-class
class _MFString( object ):
MFString field/event type base-class
check( self , value )
Raise ValueError if isn't correct type
coerce( self , value )
Coerce the given value to our type Allowable types: simple string -> wrapped in a list sequence of strings (of any length) -> equivalent list returned
copyValue( self , value , copier = None )
Copy a value for copier
vrmlstr( value , lineariser = None )
Convert the given value to a VRML97 representation
class _MFTime( _MFFloat ):
MFTime field/event type base-class
Stored as a flat Numeric-python array
class _MFUInt32( _MFInt32 ):
Unsigned integer version of MFInt32 (mostly for indices)
class _MFVec( _SFArray ):
MFVecXX field/event type base-class
Stored as x * self.length Numeric Python double array
length
check( self , value )
Check that the given value is of exactly the expected type
copyValue( self , value , copier = None )
Copy a value for copier
reshape( self , value )
vrmlstr( self , value , lineariser = None )
Convert the given value to a VRML97 representation
class _MFVec2d( _MFVec ):
MFVec2d field/event type base-class
class _MFVec2f( _MFVec32 ):
MFVec2f field/event type base-class
class _MFVec32( _MFVec ):
class _MFVec3d( _MFVec ):
MFVec3d field/event type base-class
class _MFVec3f( _MFVec32 ):
MFVec3f field/event type base-class
class _MFVec4d( _MFVec ):
MFVec4d field/event type base-class
class _MFVec4f( _MFVec32 ):
MFVec4f field/event type base-class
class _SFArray( object ):
Base class which holds a single array-type value (can be arbitrarily spec'd numpy array)
check( self , value )
Check that the given value is of exactly the expected type
coerce( self , value )
copyValue( self , value , copier = None )
Copy a value for copier
reshape( self , value )
Do reshape of value to our target dimensions
vrmlstr( self , value , lineariser = None )
Convert the given value to a VRML97 representation
class _SFArray32( _SFArray ):
32-bit version of SFArrays
class _SFBool( object ):
SFBool field/event type base-class
check( self , value )
Check that the given value is of exactly expected type
coerce( self , value )
Coerce the given value to our type Allowable types: any object with true/false protocol
vrmlstr( self , value , lineariser = None )
Convert the given value to a VRML97 representation
class _SFColor( _Color_SFVec3f ):
SFColor field/event type base-class
coerce( self , value )
Adds string-coercion for color data types
class _SFFloat( object ):
SFFloat field/event type base-class
check( self , value )
Check that value is of precisely the expected data type
coerce( self , value )
Coerce the given value to our type Allowable types: any object with true/false protocol
vrmlstr( value , lineariser = None )
Convert floats to (compact) VRML97 representation
class _SFImage( _MFInt32 ):
SFImage field/event type base-class
SFImage = MFInt32, should do something more intelligent, such as auto-compiling those to mip-mapped images, or at least storing them efficiently.
class _SFInt32( object ):
SFInt32 field/event type base-class
check( self , value )
Check that the given value is of exactly expected type
coerce( self , value )
Coerce the given value to our type Allowable types: any object with true/false protocol
vrmlstr( self , value , lineariser = None )
Convert the given value to a VRML97 representation
class _SFMatrix3d( _SFVec ):
3x3 matrix field/event type base-class
class _SFMatrix3f( _SFVec32 ):
3x3 matrix field/event type base-class
defaultDefault( self )
Default default value for vectors/colours
class _SFMatrix4d( _SFVec ):
4x4 matrix field/event type base-class
class _SFMatrix4f( _SFVec32 ):
4x4 matrix field/event type base-class
defaultDefault( self )
Default default value for vectors/colours
class _SFRotation( _SFVec32 ):
SFRotation field/event type base-class
class _SFString( object ):
SFString field/event type base-class
check( self , value )
Raise ValueError if isn't correct type
coerce( self , value )
Coerce the given value to our type Allowable types: simple string -> unchanged unicode string -> utf-8 encoded
sequence of length == 1 where first element is a string -> returns first element sequence of length > 1 where all elements are strings -> returns string.join( value, '')
vrmlstr( value , lineariser = None )
Convert the given value to a VRML97 representation
class _SFTime( _SFFloat ):
SFTime field/event type base-class
class _SFUInt32( _SFInt32 ):
SFUInt32 base-class
check( self , value )
Check that the given value is of exactly expected type
coerce( self , value )
Coerce the given value to our type Allowable types: any object with true/false protocol
vrmlstr( self , value , lineariser = None )
Convert the given value to a VRML97 representation
class _SFVec( object ):
SFVecXX field/event type base-class
Stored as a Numeric-python double array of self.length
length
coerce( self , value )
Base coercion mechanism for vector-like field types
copyValue( self , value , copier = None )
Copy a value for copier
defaultDefault( self )
Default default value for vectors/colours
vrmlstr( self , value , lineariser = None )
Convert the given value to a VRML97 representation
class _SFVec2d( _SFVec ):
SFVec2f field/event type base-class
class _SFVec2f( _SFVec32 ):
SFVec2f field/event type base-class
class _SFVec32( _SFVec ):
class _SFVec3d( _SFVec ):
SFVec3f field/event type base-class
class _SFVec3f( _SFVec32 ):
SFVec3f field/event type base-class
class _SFVec4d( _SFVec ):
SFVec4f field/event type base-class
class _SFVec4f( _SFVec32 ):
SFVec4f field/event type base-class
class MFColor( _MFColorField ):
MFColor Field class
class MFColorEvt( _MFColorEvent ):
MFColor Event class
class MFFloat( _MFFloatField ):
MFFloat Field class
class MFFloat32( _MFFloat32Field ):
MFFloat32 Field class
class MFFloat32Evt( _MFFloat32Event ):
MFFloat32 Event class
class MFFloatEvt( _MFFloatEvent ):
MFFloat Event class
class MFInt32( _MFInt32Field ):
MFInt32 Field class
class MFInt32Evt( _MFInt32Event ):
MFInt32 Event class
class MFMatrix3d( _MFMatrix3dField ):
MFMatrix3d Field class
class MFMatrix3dEvt( _MFMatrix3dEvent ):
MFMatrix3d Field class
class MFMatrix3f( _MFMatrix3fField ):
MFMatrix3f Field class
class MFMatrix3fEvt( _MFMatrix3fEvent ):
MFMatrix3f Field class
class MFMatrix4d( _MFMatrix4dField ):
MFMatrix4d Field class
class MFMatrix4dEvt( _MFMatrix4dEvent ):
MFMatrix3d Field class
class MFMatrix4f( _MFMatrix4fField ):
MFMatrix4f Field class
class MFMatrix4fEvt( _MFMatrix4fEvent ):
MFMatrix4f Field class
class MFRotation( _MFRotationField ):
MFRotation Field class
class MFRotationEvt( _MFRotationEvent ):
MFRotation Event class
class MFString( _MFStringField ):
MFString Field class
class MFStringEvt( _MFStringEvent ):
MFString Event class
class MFTime( _MFTimeField ):
MFTime Field class
class MFTimeEvt( _MFTimeEvent ):
MFTime Event class
class MFUInt32( _MFUInt32Field ):
MFUInt32 Field class
class MFUInt32Evt( _MFUInt32Event ):
MFUInt32 Event class
class MFVec2d( _MFVec2fField ):
MFVec2d Field class
class MFVec2dEvt( _MFVec2dEvent ):
MFVec2d Event class
class MFVec2f( _MFVec2fField ):
MFVec2f Field class
class MFVec2fEvt( _MFVec2fEvent ):
MFVec2f Event class
class MFVec3d( _MFVec3dField ):
MFVec3d Field class
class MFVec3dEvt( _MFVec3dEvent ):
MFVec3d Event class
class MFVec3f( _MFVec3fField ):
MFVec3f Field class
class MFVec3fEvt( _MFVec3fEvent ):
MFVec3f Event class
class MFVec4d( _MFVec4dField ):
MFVec4d Field class
class MFVec4dEvt( _MFVec4dEvent ):
MFVec4d Event class
class MFVec4f( _MFVec4fField ):
MFVec4f Field class
class MFVec4fEvt( _MFVec4fEvent ):
MFVec4f Event class
class SFArray( _SFArrayField ):
SFArray Field class
class SFArray32( _SFArray32Field ):
SFArray32 Field class
class SFArray32Evt( _SFArray32Event ):
SFArray32 Event class
class SFArrayEvt( _SFArrayEvent ):
SFArray Event class
class SFBool( _SFBoolField ):
SFBool Field class
class SFBoolEvt( _SFBoolEvent ):
SFBool Event class
class SFColor( _SFColorField ):
SFColor Field class
class SFColorEvt( _SFColorEvent ):
SFColor Event class
class SFFloat( _SFFloatField ):
SFFloat Field class
class SFFloatEvt( _SFFloatEvent ):
SFFloat Event class
class SFImage( _SFImageField ):
SFImage Field class
class SFImageEvt( _SFImageEvent ):
SFImage Event class
class SFInt32( _SFInt32Field ):
SFInt32 Field class
class SFInt32Evt( _SFInt32Event ):
SFInt32 Event class
class SFMatrix3d( _SFMatrix3dField ):
SFMatrix3d Field class
class SFMatrix3dEvt( _SFMatrix3dEvent ):
SFMatrix3d Field class
class SFMatrix3f( _SFMatrix3fField ):
SFMatrix3f Field class
class SFMatrix3fEvt( _SFMatrix3fEvent ):
SFMatrix3f Field class
class SFMatrix4d( _SFMatrix4dField ):
SFMatrix4d Field class
class SFMatrix4dEvt( _SFMatrix4dEvent ):
SFMatrix3d Field class
class SFMatrix4f( _SFMatrix4fField ):
SFMatrix4f Field class
class SFMatrix4fEvt( _SFMatrix4fEvent ):
SFMatrix4f Field class
class SFRotation( _SFRotationField ):
SFRotation Field class
class SFRotationEvt( _SFRotationEvent ):
SFRotation Event class
class SFString( _SFStringField ):
SFString Field class
class SFStringEvt( _SFStringEvent ):
SFString Event class
class SFTime( _SFTimeField ):
SFTime Field class
class SFTimeEvt( _SFTimeEvent ):
SFTime Event class
class SFUInt32( _SFUInt32Field ):
SFInt32 Field class
class SFUInt32Evt( _SFUInt32Event ):
SFInt32 Event class
class SFVec2d( _SFVec2dField ):
SFVec2d Field class
class SFVec2dEvt( _SFVec2dEvent ):
SFVec2d Event class
class SFVec2f( _SFVec2fField ):
SFVec2f Field class
class SFVec2fEvt( _SFVec2fEvent ):
SFVec2f Event class
class SFVec3d( _SFVec3dField ):
SFVec3f Field class
class SFVec3dEvt( _SFVec3dEvent ):
SFVec3d Event class
class SFVec3f( _SFVec3fField ):
SFVec3f Field class
class SFVec3fEvt( _SFVec3fEvent ):
SFVec3f Event class
class SFVec4d( _SFVec4dField ):
SFVec4d Field class
class SFVec4dEvt( _SFVec4dEvent ):
SFVec4f Event class
class SFVec4f( _SFVec4fField ):
SFVec4f Field class
class SFVec4fEvt( _SFVec4fEvent ):
SFVec4f Event class