# class FieldData

FieldData represents multiple fields of data. Each field is implemented as an ValueArray object, that has a unique name, and can have complex components (such as scalars, vectors, quaternions, tensors or matrices). All fields are assumed to be of the same length. IFieldData can be seen as an array with complex tuples, where the component can be of different types.

# Properties

# Methods

# Static methods

# Properties details

# Name

The name of the FieldData object. (Inherited from Object)

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

# TupleCount

Resizes/Gets the list to the specified tuple count. If the list is enlarged, the new tuples will contain unspecified data.

// Setter
void SetTupleCount( unsigned int tuplecount ) const;

// Getter
unsigned int GetTupleCount() const;

// Setter
void SetTupleCount(uint tuplecount);

// Getter
uint GetTupleCount();

# Setter
None SetTupleCount(tuplecount: int)

# Getter
int GetTupleCount()

# Methods details

# AddBaseTypeField

Adds a field based on a base type. Only ValueArray objects are allowed. The created and added object is returned.

spValueArray AddBaseTypeField( Simplygon::EBaseTypes baseType , unsigned int tupleSize , const char * name ) const;

spValueArray AddBaseTypeField(EBaseTypes baseType, uint tupleSize, string name);

spValueArray AddBaseTypeField(baseType: EBaseTypes_*, tupleSize: int, name: str)

# AddField

Adds a field. The field must have a unique name set.

void AddField( const spValueArray & field ) const;

void AddField(spValueArray field);

None AddField(field: spValueArray)

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

# AddTupleCount

Adds a number of tuples to the current tuple count.

void AddTupleCount( unsigned int tuplecount ) const;

void AddTupleCount(uint tuplecount);

None AddTupleCount(tuplecount: int)

# AppendTuples

Appends another field data object to this object. The fields are allowed to be setup differently, but then comes at a significant performance penalty. If fields in the other field data object is missing in this object, these will be added, and the items in the old tuples will be set to 0.

void AppendTuples( const spFieldData & other , bool addMissingFields ) const;

void AppendTuples(spFieldData other, bool addMissingFields);

None AppendTuples(other: spFieldData, addMissingFields: bool)

# Clear

Clears all tuples from the fields. The fields, however, are not removed.

void Clear() const;

void Clear();

None Clear()

# CopyCombine3Tuples

CopyCombine3Tuples combines the data from three tuples into a destination tuple. The call works like CombineTuples, but there is three source tuples, and two alpha values. the destination will be weighted by the values: alpha_3 = 1-(alpha_1 + alpha_2) dest = src_1*alpha_1 + src_2*alpha_2 + src_3*alpha_3 This field data object can be used as the source field data object to copy within the object.

void CopyCombine3Tuples( const spFieldData & source , rid destId , rid srcId1 , rid srcId2 , rid srcId3 , real alpha1 , real alpha2 ) const;

void CopyCombine3Tuples(spFieldData source, int destId, int srcId1, int srcId2, int srcId3, float alpha1, float alpha2);

None CopyCombine3Tuples(source: spFieldData, destId: int, srcId1: int, srcId2: int, srcId3: int, alpha1: float, alpha2: float)

# CopyCombineTuples

CopyCombineTuples() combines the data from two tuples into a destination tuple. This field data object can be used as the source field data object to copy within the object.

void CopyCombineTuples( const spFieldData & source , rid destId , rid srcId1 , rid srcId2 , real alpha ) const;

void CopyCombineTuples(spFieldData source, int destId, int srcId1, int srcId2, float alpha);

None CopyCombineTuples(source: spFieldData, destId: int, srcId1: int, srcId2: int, alpha: float)

# CopyRange

CopyRange() copies a range of tuples from a source field object into this field object. The field objects must have the same field setup. This field object must be resized to hold the tuples before copying.

void CopyRange( const spFieldData & source , rid startDestId , rid startSrcId , unsigned int count ) const;

void CopyRange(spFieldData source, int startDestId, int startSrcId, uint count);

None CopyRange(source: spFieldData, startDestId: int, startSrcId: int, count: int)

# CopyTuple

CopyTuple() copies one tuple to another. Both the dest_id and the source_id must exist in the array. This field data object can be used as the source field data object to copy within the object.

void CopyTuple( const spFieldData & source , rid destId , rid srcId ) const;

void CopyTuple(spFieldData source, int destId, int srcId);

None CopyTuple(source: spFieldData, destId: int, srcId: int)

# DeepCopy

Copies the field setup and data from another object. To only copy the setup, set copy_data to false.

void DeepCopy( const spFieldData & source , bool copyData ) const;

void DeepCopy(spFieldData source, bool copyData);

None DeepCopy(source: spFieldData, copyData: bool)

# ExtractTuples

Extracts a range of tuples from this object. The receiving object is assumed to have exactly the same data fields as this object.

void ExtractTuples( const spFieldData & dest , rid start , unsigned int count ) const;

void ExtractTuples(spFieldData dest, int start, uint count);

None ExtractTuples(dest: spFieldData, start: int, count: int)

# GetClass

Get the name of the FieldData class. (Inherited from Object)

spString GetClass() const;

string GetClass();

str GetClass()

# GetField

Retrieves a field. If the field was not found, null is returned.

spValueArray GetField( const char * name ) const;

spValueArray GetField(string name);

spValueArray GetField(name: str)

# GetFieldCount

Returns the number of fields in the field data object. The ids of the fields range from 0 through (GetFieldCount()-1).

unsigned int GetFieldCount() const;

uint GetFieldCount();

int GetFieldCount()

# GetFieldWithHandle

Returns the field associated with the specified handle.

spValueArray GetFieldWithHandle( rhandle hand ) const;

spValueArray GetFieldWithHandle(System.IntPtr hand);

spValueArray GetFieldWithHandle(hand: PyObject*)

# GetFieldWithId

Retrieves a field from its index in the field data.

spValueArray GetFieldWithId( rid id ) const;

spValueArray GetFieldWithId(int id);

spValueArray GetFieldWithId(id: int)

# GetFirstFieldHandle

Returns the handle of the first field, or null if no fields are added to the object.

rhandle GetFirstFieldHandle() const;

System.IntPtr GetFirstFieldHandle();

PyObject* GetFirstFieldHandle()

# GetMaxFieldId

Returns the id of the field with the highest id. NOTE! If no fields exist in the field data object, the return is undefined.

rid GetMaxFieldId() const;

int GetMaxFieldId();

int GetMaxFieldId()

# GetMaxTupleId

Returns the id of the last tuple in the array. If the array is empty, the value is undefined.

rid GetMaxTupleId() const;

int GetMaxTupleId();

int GetMaxTupleId()

# GetNextFieldHandle

Returns the next handle, or null if no more fields exist in the object.

rhandle GetNextFieldHandle( rhandle hand ) const;

System.IntPtr GetNextFieldHandle(System.IntPtr hand);

PyObject* GetNextFieldHandle(hand: PyObject*)

# IndexedCombine

Works like IndexedCopy, but uses two consecutive ids in the idtable, and a blend value from the blendtable. The idtable contains (idtable_cnt*2) indices and blendtable contains idtable_cnt blend values. Does the blend: dest = src1*(1-blend) + src2*blend The FieldData must have enough tuples to hold the new data.

void IndexedCombine( const spFieldData & source , const spRidArray & idtable , const spRealArray & blendtable , rid startId ) const;

void IndexedCombine(spFieldData source, spRidArray idtable, spRealArray blendtable, int startId);

None IndexedCombine(source: spFieldData, idtable: spRidArray, blendtable: spRealArray, startId: int)

# IndexedCombine3

Works like IndexedCombine(), but with three ids that are combined through two blend values in the blendtable. The idtable contains (idtable_cnt*3) indices and blendtable contains (idtable_cnt*2) blend values. Does the blend: dest = src1*blend1 + src2*blend2 + src3*(1-(blend1+blend2)) The FieldData must have enough tuples to hold the new data.

void IndexedCombine3( const spFieldData & source , const spRidArray & idtable , const spRealArray & blendtable , rid startId ) const;

void IndexedCombine3(spFieldData source, spRidArray idtable, spRealArray blendtable, int startId);

None IndexedCombine3(source: spFieldData, idtable: spRidArray, blendtable: spRealArray, startId: int)

# IndexedCopy

Copies tuples from a source field data object through an id table. The id table dictates the order in which the tuples are to be copied. E.g. If the first item in the id table has the value 14, then the tuple with id 14 in the source array will be copied to the first tuple in this array. Note! All ids in the id table must be valid ids of tuples in the source field data object. The id table is assumed to have a tuple size of 1. The source and this field data object must have the same underlying data fields, of the same type and the same tuple sizes. The FieldData must have enough tuples to hold the new data.

void IndexedCopy( const spFieldData & source , const spRidArray & idtable , rid startId ) const;

void IndexedCopy(spFieldData source, spRidArray idtable, int startId);

None IndexedCopy(source: spFieldData, idtable: spRidArray, startId: int)

# IsA

Returns true if FieldData is a or is a descendant of the class named as the type parameter. (Inherited from Object)

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

# IsEmpty

Returns 1 if no tuples exist in the field data.

int IsEmpty() const;

int IsEmpty();

int IsEmpty()

# IsNull

Returns true if the FieldData object is invalid. (Inherited from Object)

bool IsNull() const;

bool IsNull();

bool IsNull()

# IsSameObjectAs

Returns true if the FieldData object is valid. (Inherited from Object)

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

# IsSetupIdenticalTo

Compares the field setup of this field data object to another field data object. If the setups are not identical, false is returned. Note! IsSetupIdenticalTo will return false even if the same fields exist in both field data objects, but are not in the same order.

bool IsSetupIdenticalTo( const spFieldData & other ) const;

bool IsSetupIdenticalTo(spFieldData other);

bool IsSetupIdenticalTo(other: spFieldData)

# NewCopy

Creates another field data object with the same field setup. To also copy the data to the new object, set copy_data to true.

spFieldData NewCopy( bool copyData ) const;

spFieldData NewCopy(bool copyData);

spFieldData NewCopy(copyData: bool)

# NewPackedCopy

Like NewCopy, NewPackedCopy creates a field data object with the same underlying data and tuple settings as the source field data object. However, NewPackedCopy only copies unique tuples, and if the index_array parameter is set, this index array will contain the same number of tuples as the source field data object, and with the ids of a specific tuples within the new copy of the field data object.

spFieldData NewPackedCopy( const spRidArray & indexArray ) const;

spFieldData NewPackedCopy(spRidArray indexArray);

spFieldData NewPackedCopy(indexArray: spRidArray)

# NonNull

Returns true if the FieldData object is valid. (Inherited from Object)

bool NonNull() const;

bool NonNull();

bool NonNull()

# PrintInfo

Prints the content/info of the FieldData object to the log. (Inherited from Object)

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

# RemoveAllFields

Clears all fields from the object. Releases all data in the object.

void RemoveAllFields() const;

void RemoveAllFields();

None RemoveAllFields()

# RemoveField

Removes a field. Removing a field causes the remaining fields to be remapped to new ids. Note that the field must exist. If not, the method will return error. To remove a field that may not exist, use SafeRemoveField.

void RemoveField( const char * name ) const;

void RemoveField(string name);

None RemoveField(name: str)

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

# SafeRemoveField

Removes a field. Removing a field causes the remaining fields to be remapped to new ids.

void SafeRemoveField( const char * name ) const;

void SafeRemoveField(string name);

None SafeRemoveField(name: str)

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

static bool IsClassA( const char * type ) const;

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spFieldData, and if this is the case, returns the object cast into spFieldData. (Inherited from Object)

static spFieldData SafeCast( const spObject & object ) const;

static spFieldData SafeCast(spObject object);

@staticmethod
spFieldData SafeCast(object: spObject)