Module vrFieldAccess :: Class vrFieldAccess
[frames] | no frames]

Class vrFieldAccess

 object --+    
          |    
??.instance --+
              |
             vrFieldAccess

The vrFieldAccess class offers access to any kind of data (fields) inside the scenegraph (regardless if it is a node, a geometry, material etc.). You get access to the fieldpointer within the materials or nodes via the fields()-method.

The names of the fields can be found in the node editor. The type of a field is shown in a tool tip when hovering over the right side column in the table of the Node Editor.

A type beginning with 'SF...' stands for Single field, it holds a single value or object. For example, 'SFInt8' means the field holds an 8 bit int value. It can be accessed with setInt8 and getInt8.

A type beginning with 'MF...' means it is a multi-field. A multi field is a list of values or objects. For example, 'MFString' is a list of strings.The methods for multi fields start with getM... or setM..., for example setMString and getMString for a string multi field.

Example:

       See toggleClipPlane() in deprecated/clipPlane.py
Instance Methods
 
__init__(source)
The constructor of the FieldContainerPtr class.
 
__reduce__()
bool
addAttachment(attachment)
Adds an attachment to an AttachmentContainer.
FieldContainerPtr
getAttachment(aname)
Returns the attachment.
bool
getBool(fname)
Returns the value of a bool field.
list of floats (32bit)
getColor(fname, d)
Returns the value of a color field.
FieldContainerPtr
getFieldContainer(fname)
Returns the value of a field container.
unsigned int (32bit)
getFieldContainerID(fname)
Returns the id of a field container.
unsigned int (32bit)
getFieldContainerId(fname)
Returns the id of a field container.
GLenum
getGLenum(fname)
Returns the value of a GLenum field.
unsigned int (32bit)
getID()
Returns the internal id of the field container.
int (16bit)
getInt16(fname)
Returns the value of a short field (16bit signed).
int (32bit)
getInt32(fname)
Returns the value of an int field (32bit signed).
int (64bit)
getInt64(fname)
Returns the value of an int field (64bit signed).
int (8bit)
getInt8(fname)
Returns the value of a short field (8bit signed).
list of booleans
getMBool(fname)
Returns the values of a boolean multi field.
list of Color3fs
getMColor3f(fname)
Returns the values of a Color3f multi field.
list of Color4fs
getMColor4f(fname)
Returns the values of a Color4f multi field.
list of FieldContainerPtrs
getMFieldContainer(fname)
Returns a FieldContainerPtr multi field.
list of unsigned ints (32bit)
getMFieldContainerId(fname)
Returns the field container ids of a FieldContainerPtr multi field.
list of GLenums
getMGLenum(fname)
Returns the values of a GLenum multi field.
list of integers (signed 16 bit)
getMInt16(fname)
Returns the values of an integer multi field.
list of integers (signed 32 bit)
getMInt32(fname)
Returns the values of an integer multi field.
list of integers (signed 64 bit)
getMInt64(fname)
Returns the values of an integer multi field.
list of integers (signed 8 bit)
getMInt8(fname)
Returns the values of an integer multi field.
list of Pnt2fs
getMPnt2f(fname)
Returns the values of a Pnt2f multi field.
list of Pnt3fs
getMPnt3f(fname)
Returns the values of a Pnt3f multi field.
list of Pnt4fs
getMPnt4f(fname)
Returns the values of a Pnt4f multi field.
list of floats (32 bit)
getMReal32(fname)
Returns the values of a float multi field.
list of floats (64 bit)
getMReal64(fname)
Returns the values of a float multi field.
list of strings
getMString(fname)
Returns the values of a string multi field.
list of unsigned ints (16 bit)
getMUInt16(fname)
Returns the values of an unsigned int multi field.
list of unsigned ints (32 bit)
getMUInt32(fname)
Returns the values of an unsigned int multi field.
list of unsigned ints (64 bit)
getMUInt64(fname)
Returns the values of an unsigned int multi field.
list of unsigned ints (8 bit)
getMUInt8(fname)
Returns the values of an unsigned int multi field.
list of Vec2fs
getMVec2f(fname)
Returns the values of a Vec2f multi field.
list of Vec3fs
getMVec3f(fname)
Returns the values of a Vec3f multi field.
list of Vec4fs
getMVec4f(fname)
Returns the values of a Vec4f multi field.
list of floats (32bit)
getMatrix(fname)
Returns the value of a matrix field.
NodePtr
getNode(fname)
Returns the value of a node field.
list of floats (32bit)
getPnt(fname, d)
Returns the value of a point field.
float (32bit)
getReal32(fname)
Returns the value of a float field (32bit).
float (64bit)
getReal64(fname)
Returns the value of a double field (64bit).
string
getString(fname)
Returns the value of a string field.
time (float 64bit)
getTime(fname)
Returns the value of a time field (64bit).
unsigned int (16bit)
getUInt16(fname)
Returns the value of an unsigned short field (16bit unsigned).
unsigned int (32bit)
getUInt32(fname)
Returns the value of an unsigned int field (32bit unsigned).
unsigned int (64bit)
getUInt64(fname)
Returns the value of an unsigned int field (64bit unsigned).
unsigned int (8bit)
getUInt8(fname)
Returns the value of an unsigned short field (8bit unsigned).
list of floats (32bit)
getVec(fname, d)
Returns the value of a vector field.
bool
hasAttachment(fname)
Checks the existence of an attachment via name.
bool
hasField(fname)
Checks the existence of a field via name.
bool
isValid()
Returns true if the FieldContainer is valid.
 
setBool(fname, v)
Sets the value of a bool field.
 
setColor(fname, v)
Sets an n-dimensional color field (n in [3,4]).
 
setColor4f(fname, r, g, b, a)
Sets a 4-dimensional color field.
 
setFieldContainer(fname, v)
Sets the value of a fieldcontainer field.
 
setFieldContainerId(fname, v)
Sets the value of a fieldcontainer field.
 
setGLenum(fname, v)
Sets the value of a GLenum field.
 
setInt16(fname, v)
Sets the value of a short field.
 
setInt32(fname, v)
Sets the value of an int field.
 
setInt64(fname, v)
Sets the value of an int field.
 
setInt8(fname, v)
Sets the value of a byte field.
 
setMBool(fname, v)
Sets the value of a bool multi field.
 
setMColor3f(fname, v)
Sets the value of a Color3f multi field.
 
setMColor4f(fname, v)
Sets the value of a Color4f multi field.
 
setMFieldContainer(fname, v)
Sets the value of a fieldcontainer multi field.
 
setMFieldContainerId(fname, v)
Sets the value of a fieldcontainer multi field.
 
setMGLenum(fname, v)
Sets the value of a GLenum multi field.
 
setMInt16(fname, v)
Sets the value of an int multi field.
 
setMInt32(fname, v)
Sets the value of an integer multi field.
 
setMInt64(fname, v)
Sets the value of an integer multi field.
 
setMInt8(fname, v)
Sets the value of an int multi field.
 
setMPnt2f(fname, v)
Sets the value of a Pnt2f multi field.
 
setMPnt3f(fname, v)
Sets the value of a Pnt3f multi field.
 
setMPnt4f(fname, v)
Sets the value of a Pnt4f multi field.
 
setMReal32(fname, v)
Sets the value of a float multi field.
 
setMReal64(fname, v)
Sets the value of a float multi field.
 
setMString(fname, v)
Sets the value of a string multi field.
 
setMUInt16(fname, v)
Sets the value of an unsigned int multi field.
 
setMUInt32(fname, v)
Sets the value of a unsigned int multi field.
 
setMUInt64(fname, v)
Sets the value of a unsigned int multi field.
 
setMUInt8(fname, v)
Sets the value of an unsigned int multi field.
 
setMVec2f(fname, v)
Sets the value of a Vec2f multi field.
 
setMVec3f(fname, v)
Sets the value of a Vec3f multi field.
 
setMVec4f(fname, v)
Sets the value of a Vec4f multi field.
 
setMatrix(fname, v, transposed)
Sets an 16-dimensional matrix field.
 
setNode(fname, v)
Sets the value of a node field.
 
setPnt(fname, v)
Sets the value of an n-dimensional point field (n in [2,4]).
 
setPnt2f(fname, x, y)
Sets the value of a 2-dimensional point field.
 
setPnt3f(fname, x, y, z)
Sets the value of a 3-dimensional point field.
 
setReal32(fname, v)
Sets the value of a float field.
 
setReal64(fname, v)
Sets the value of a double field.
 
setString(fname, v)
Sets the value of a string field.
 
setTime(fname, v)
Sets the value of a time field.
 
setUInt16(fname, v)
Sets the value of an unsigned short field.
 
setUInt32(fname, v)
Sets the value of an unsigned int field.
 
setUInt64(fname, v)
Sets the value of an unsigned int field.
 
setUInt8(fname, v)
Sets the value of an unsigned byte field.
 
setVec(fname, v)
Sets the value of an n-dimensional vector field (n in [2,4]).
 
setVec2f(fname, x, y)
Sets the value of a 2-dimensional vector field.
 
setVec3f(fname, x, y, z)
Sets the value of a 3-dimensional vector field.
 
setVec4f(fname, x, y, z, w)
Sets the value of a 4-dimensional vector field.
bool
subAttachment(attachment)
Removes an attachment from the AttachmentContainer.

Inherited from unreachable.instance: __new__

Class Variables
  __instance_size__ = 40
Method Details

__init__(source)
(Constructor)

 

The constructor of the FieldContainerPtr class.

Parameters:
  • source (FieldContainerPtr) - The source (Optional).
Overrides: object.__init__

__reduce__()

 
Overrides: object.__reduce__
(inherited documentation)

addAttachment(attachment)

 

Adds an attachment to an AttachmentContainer.

Parameters:
  • attachment (FieldContainerPtr) - The attachment to add.
Returns: bool
true of false.

getAttachment(aname)

 

Returns the attachment.

Parameters:
  • aname (string) - The name of the attachment.
Returns: FieldContainerPtr
The value.

getBool(fname)

 

Returns the value of a bool field.

Parameters:
  • fname (string) - The name of the field.
Returns: bool
The value.

getColor(fname, d)

 

Returns the value of a color field.

Parameters:
  • fname (string) - The name of the field.
  • d (int) - The dimension of the field (d in [3,4]).
Returns: list of floats (32bit)
The values.

getFieldContainer(fname)

 

Returns the value of a field container.

Parameters:
  • fname (string) - The name of the field.
Returns: FieldContainerPtr
The value.

getFieldContainerID(fname)

 

Returns the id of a field container.

Parameters:
  • fname (string) - The name of the field.
Returns: unsigned int (32bit)
The FieldContainer id.

getFieldContainerId(fname)

 

Returns the id of a field container.

Parameters:
  • fname (string) - The name of the field.
Returns: unsigned int (32bit)
The FieldContainer id.

getGLenum(fname)

 

Returns the value of a GLenum field.

Parameters:
  • fname (string) - The name of the field.
Returns: GLenum
The value.

getID()

 

Returns the internal id of the field container.

Returns: unsigned int (32bit)
The field container id.

getInt16(fname)

 

Returns the value of a short field (16bit signed).

Parameters:
  • fname (string) - The name of the field.
Returns: int (16bit)
The value.

getInt32(fname)

 

Returns the value of an int field (32bit signed).

Parameters:
  • fname (string) - The name of the field.
Returns: int (32bit)
The value.

getInt64(fname)

 

Returns the value of an int field (64bit signed).

Parameters:
  • fname (string) - The name of the field.
Returns: int (64bit)
The value.

getInt8(fname)

 

Returns the value of a short field (8bit signed).

Parameters:
  • fname (string) - The name of the field.
Returns: int (8bit)
The value.

getMBool(fname)

 

Returns the values of a boolean multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of booleans
The values.

getMColor3f(fname)

 

Returns the values of a Color3f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Color3fs
The values.

getMColor4f(fname)

 

Returns the values of a Color4f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Color4fs
The values.

getMFieldContainer(fname)

 

Returns a FieldContainerPtr multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of FieldContainerPtrs
The FieldContainerPtrs.

getMFieldContainerId(fname)

 

Returns the field container ids of a FieldContainerPtr multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of unsigned ints (32bit)
The FieldContainer ids.

getMGLenum(fname)

 

Returns the values of a GLenum multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of GLenums
The values.

getMInt16(fname)

 

Returns the values of an integer multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of integers (signed 16 bit)
The values.

getMInt32(fname)

 

Returns the values of an integer multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of integers (signed 32 bit)
The values.

getMInt64(fname)

 

Returns the values of an integer multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of integers (signed 64 bit)
The values.

getMInt8(fname)

 

Returns the values of an integer multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of integers (signed 8 bit)
The values.

getMPnt2f(fname)

 

Returns the values of a Pnt2f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Pnt2fs
The values.

getMPnt3f(fname)

 

Returns the values of a Pnt3f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Pnt3fs
The values.

getMPnt4f(fname)

 

Returns the values of a Pnt4f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Pnt4fs
The values.

getMReal32(fname)

 

Returns the values of a float multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of floats (32 bit)
The values.

getMReal64(fname)

 

Returns the values of a float multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of floats (64 bit)
The values.

getMString(fname)

 

Returns the values of a string multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of strings
The values.

getMUInt16(fname)

 

Returns the values of an unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of unsigned ints (16 bit)
The values.

getMUInt32(fname)

 

Returns the values of an unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of unsigned ints (32 bit)
The values.

getMUInt64(fname)

 

Returns the values of an unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of unsigned ints (64 bit)
The values.

getMUInt8(fname)

 

Returns the values of an unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of unsigned ints (8 bit)
The values.

getMVec2f(fname)

 

Returns the values of a Vec2f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Vec2fs
The values.

getMVec3f(fname)

 

Returns the values of a Vec3f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Vec3fs
The values.

getMVec4f(fname)

 

Returns the values of a Vec4f multi field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of Vec4fs
The values.

getMatrix(fname)

 

Returns the value of a matrix field.

Parameters:
  • fname (string) - The name of the field.
Returns: list of floats (32bit)
The values.

getNode(fname)

 

Returns the value of a node field.

Parameters:
  • fname (string) - The name of the field.
Returns: NodePtr
The value.

getPnt(fname, d)

 

Returns the value of a point field.

Parameters:
  • fname (string) - The name of the field.
  • d (int) - The dimension of the field (d in [2,4]).
Returns: list of floats (32bit)
The values.

getReal32(fname)

 

Returns the value of a float field (32bit).

Parameters:
  • fname (string) - The name of the field.
Returns: float (32bit)
The value.

getReal64(fname)

 

Returns the value of a double field (64bit).

Parameters:
  • fname (string) - The name of the field.
Returns: float (64bit)
The value.

getString(fname)

 

Returns the value of a string field.

Parameters:
  • fname (string) - The name of the field.
Returns: string
The value.

getTime(fname)

 

Returns the value of a time field (64bit).

Parameters:
  • fname (string) - The name of the field.
Returns: time (float 64bit)
The value.

getUInt16(fname)

 

Returns the value of an unsigned short field (16bit unsigned).

Parameters:
  • fname (string) - The name of the field.
Returns: unsigned int (16bit)
The value.

getUInt32(fname)

 

Returns the value of an unsigned int field (32bit unsigned).

Parameters:
  • fname (string) - The name of the field.
Returns: unsigned int (32bit)
The value.

getUInt64(fname)

 

Returns the value of an unsigned int field (64bit unsigned).

Parameters:
  • fname (string) - The name of the field.
Returns: unsigned int (64bit)
The value.

getUInt8(fname)

 

Returns the value of an unsigned short field (8bit unsigned).

Parameters:
  • fname (string) - The name of the field.
Returns: unsigned int (8bit)
The value.

getVec(fname, d)

 

Returns the value of a vector field.

Parameters:
  • fname (string) - The name of the field.
  • d (int) - The dimension of the field (d in [2,4]).
Returns: list of floats (32bit)
The values.

hasAttachment(fname)

 

Checks the existence of an attachment via name.

Parameters:
  • fname (string) - The name of the attachment.
Returns: bool
The existence (true or false).

hasField(fname)

 

Checks the existence of a field via name.

Parameters:
  • fname (string) - The name of the field.
Returns: bool
The existence (true or false).

isValid()

 

Returns true if the FieldContainer is valid.

Returns: bool
True if valid, false otherwise.

setBool(fname, v)

 

Sets the value of a bool field.

Parameters:
  • fname (string) - The name of the field.
  • v (boolean) - The value (true or false).

setColor(fname, v)

 

Sets an n-dimensional color field (n in [3,4]).

Parameters:
  • fname (string) - The name of the field.
  • v (list of floats (32bit)) - The list of values e.g.[1.0, 2.0].

setColor4f(fname, r, g, b, a)

 

Sets a 4-dimensional color field.

Parameters:
  • fname (string) - The name of the field.
  • r (float (32bit)) - The red value.
  • g (float (32bit)) - The green value.
  • b (float (32bit)) - The blue value.
  • a (float (32bit)) - The alpha value.

setFieldContainer(fname, v)

 

Sets the value of a fieldcontainer field.

Parameters:
  • fname (string) - The name of the field.
  • v (FieldContainerPtr) - The value.

setFieldContainerId(fname, v)

 

Sets the value of a fieldcontainer field.

Parameters:
  • fname (string) - The name of the field.
  • v (unsigned int (32bit)) - The FieldContainer id.

setGLenum(fname, v)

 

Sets the value of a GLenum field.

Parameters:
  • fname (string) - The name of the field.
  • v (GLenum) - The value.

setInt16(fname, v)

 

Sets the value of a short field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (signed 16bit)) - The value.

setInt32(fname, v)

 

Sets the value of an int field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (signed 32bit)) - The value.

setInt64(fname, v)

 

Sets the value of an int field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (signed 64bit)) - The value.

setInt8(fname, v)

 

Sets the value of a byte field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (signed 8bit)) - The value.

setMBool(fname, v)

 

Sets the value of a bool multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of bools (32bit)) - The values.

setMColor3f(fname, v)

 

Sets the value of a Color3f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Color3fs) - The values.

setMColor4f(fname, v)

 

Sets the value of a Color4f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Color4fs) - The values.

setMFieldContainer(fname, v)

 

Sets the value of a fieldcontainer multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of FieldContainerPtr) - The FieldContainerPtrs.

setMFieldContainerId(fname, v)

 

Sets the value of a fieldcontainer multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of unsigned ints (32bit)) - The FieldContainer ids.

setMGLenum(fname, v)

 

Sets the value of a GLenum multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of GLenums (32bit)) - The values.

setMInt16(fname, v)

 

Sets the value of an int multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of ints (16bit)) - The values.

setMInt32(fname, v)

 

Sets the value of an integer multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of ints (32bit)) - The values.

setMInt64(fname, v)

 

Sets the value of an integer multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of ints (64bit)) - The values.

setMInt8(fname, v)

 

Sets the value of an int multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of ints (8bit)) - The values.

setMPnt2f(fname, v)

 

Sets the value of a Pnt2f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Pnt2fs) - The values.

setMPnt3f(fname, v)

 

Sets the value of a Pnt3f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Pnt3fs) - The values.

setMPnt4f(fname, v)

 

Sets the value of a Pnt4f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Pnt4fs) - The values.

setMReal32(fname, v)

 

Sets the value of a float multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of floats (32bit)) - The values.

setMReal64(fname, v)

 

Sets the value of a float multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of floats (64bit)) - The values.

setMString(fname, v)

 

Sets the value of a string multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of strings) - The values.

setMUInt16(fname, v)

 

Sets the value of an unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of unsigned ints (16bit)) - The values.

setMUInt32(fname, v)

 

Sets the value of a unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of unsigned ints (32bit)) - The values.

setMUInt64(fname, v)

 

Sets the value of a unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of unsigned ints (64bit)) - The values.

setMUInt8(fname, v)

 

Sets the value of an unsigned int multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of unsigned ints (8bit)) - The values.

setMVec2f(fname, v)

 

Sets the value of a Vec2f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Vec2fs) - The values.

setMVec3f(fname, v)

 

Sets the value of a Vec3f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Vec3fs) - The values.

setMVec4f(fname, v)

 

Sets the value of a Vec4f multi field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of Vec4fs) - The values.

setMatrix(fname, v, transposed)

 

Sets an 16-dimensional matrix field.

Parameters:
  • fname (string) - The name of the field.
  • v (list of floats (32bit)) - The list of values.
  • transposed (bool) - Transposed/not transposed.

setNode(fname, v)

 

Sets the value of a node field.

Parameters:
  • fname (string) - The name of the field.
  • v (NodePtr) - The value.

setPnt(fname, v)

 

Sets the value of an n-dimensional point field (n in [2,4]).

Parameters:
  • fname (string) - The name of the field.
  • v (list of floats (32bit)) - The list of values e.g.[1.0, 2.0].

setPnt2f(fname, x, y)

 

Sets the value of a 2-dimensional point field.

Parameters:
  • fname (string) - The name of the field.
  • x (float (32bit)) - The x value.
  • y (float (32bit)) - The y value.

setPnt3f(fname, x, y, z)

 

Sets the value of a 3-dimensional point field.

Parameters:
  • fname (string) - The name of the field.
  • x (float (32bit)) - The x value.
  • y (float (32bit)) - The y value.
  • z (float (32bit)) - The z value.

setReal32(fname, v)

 

Sets the value of a float field.

Parameters:
  • fname (string) - The name of the field.
  • v (float (32bit)) - The value.

setReal64(fname, v)

 

Sets the value of a double field.

Parameters:
  • fname (string) - The name of the field.
  • v (float (64bit)) - The value.

setString(fname, v)

 

Sets the value of a string field.

Parameters:
  • fname (string) - The name of the field.
  • v (string) - The value.

setTime(fname, v)

 

Sets the value of a time field.

Parameters:
  • fname (string) - The name of the field.
  • v (time (float 64bit)) - The value.

setUInt16(fname, v)

 

Sets the value of an unsigned short field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (unsigned 16bit)) - The value.

setUInt32(fname, v)

 

Sets the value of an unsigned int field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (unsigned 32bit)) - The value.

setUInt64(fname, v)

 

Sets the value of an unsigned int field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (unsigned 64bit)) - The value.

setUInt8(fname, v)

 

Sets the value of an unsigned byte field.

Parameters:
  • fname (string) - The name of the field.
  • v (integer (unsigned 8bit)) - The value.

setVec(fname, v)

 

Sets the value of an n-dimensional vector field (n in [2,4]).

Parameters:
  • fname (string) - The name of the field.
  • v (list of floats (32bit)) - The list of values e.g.[1.0, 2.0].

setVec2f(fname, x, y)

 

Sets the value of a 2-dimensional vector field.

Parameters:
  • fname (string) - The name of the field.
  • x (float (32bit)) - The x value.
  • y (float (32bit)) - The y value.

setVec3f(fname, x, y, z)

 

Sets the value of a 3-dimensional vector field.

Parameters:
  • fname (string) - The name of the field.
  • x (float (32bit)) - The x value.
  • y (float (32bit)) - The y value.
  • z (float (32bit)) - The z value.

setVec4f(fname, x, y, z, w)

 

Sets the value of a 4-dimensional vector field.

Parameters:
  • fname (string) - The name of the field.
  • x (float (32bit)) - The x value.
  • y (float (32bit)) - The y value.
  • z (float (32bit)) - The z value.
  • w (float (32bit)) - The w value.

subAttachment(attachment)

 

Removes an attachment from the AttachmentContainer.

Parameters:
  • attachment (FieldContainerPtr) - The attachment to remove.
Returns: bool
true of false.