Simplygon 9 Documentation

# class GeometryDataCollection

GeometryDataCollection holds a number of GeometryData objects. The objects can be looked up by their names (if they have been named with a call to SetName).

See also: ObjectCollection

# Methods

Method Description
AddGeometryData Adds a GeometryData object to the collection. The handle refers to the GeometryData until it is removed from the collection again. If the GeometryData and the pre-existing collection shares a field name they have to be of the same type and tuple size.
AddObject Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.
AddObjectSorted Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.
FindGeometryData Finds a named object.
FindObject Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.
GetClass Get the name of the GeometryDataCollection class.
GetFirstItem Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.
GetGeometryData The object the handle is referring to.
GetItem Returns the handle of the i:th item.
GetItemAsObject Returns the object of the i:th item.
GetItemCount The number of items in the collection.
GetItemsObject The object the handle is referring to.
GetNextItem Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.
GetNextItemAsGeometryData Returns the object of the next item.
IsA Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter.
IsGeometryDataInCollection Returns true if the object is in the collection.
IsItemInCollection Returns true if the item is in the collection.
IsNull Returns true if the GeometryDataCollection object is invalid.
IsObjectInCollection Returns true if the object is in the collection.
RemoveAllItems Removes all items from the collection.
RemoveGeometryData Removes an object from the collection. Only the first occurrence of the object is removed.
RemoveItem Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.
RemoveObject Removes an object from the collection. Only the first occurance of the object is removed from the collection.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCollection, and if this is the case, returns the object cast into spGeometryDataCollection.

# Methods details

# AddGeometryData

Adds a GeometryData object to the collection. The handle refers to the GeometryData until it is removed from the collection again. If the GeometryData and the pre-existing collection shares a field name they have to be of the same type and tuple size.

# Syntax

rhandle AddGeometryData( spGeometryData obj );

# Parameters

Type Name Min Max Description
GeometryData obj The GeometryData to add.

# Return value

Type: rhandle

# AddObject

Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.

# Syntax

rhandle AddObject( spObject obj );

# Parameters

Type Name Min Max Description
Object obj The object that is to be added to the collection.

# Return value

Type: rhandle

# AddObjectSorted

Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.

# Syntax

rhandle AddObjectSorted( spObject obj , bool ascending );

# Parameters

Type Name Min Max Description
Object obj The object that is to be added to the collection.
bool ascending Determines the sorting order.

# Return value

Type: rhandle

# FindGeometryData

Finds a named object.

# Syntax

spGeometryData FindGeometryData( const char * name );

# Parameters

Type Name Min Max Description
const char * name The name of the geometry object.

# Return value

Type: GeometryData

# FindObject

Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.

# Syntax

spObject FindObject( const char * name );

# Parameters

Type Name Min Max Description
const char * name The name of an object in the collection.

# Return value

Type: Object

# GetClass

Get the name of the GeometryDataCollection class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetFirstItem

Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.

# Syntax

rhandle GetFirstItem();

# Parameters

GetFirstItem takes no parameters.

# Return value

Type: rhandle

# GetGeometryData

The object the handle is referring to.

# Syntax

spGeometryData GetGeometryData( rhandle objhandle );

# Parameters

Type Name Min Max Description
rhandle objhandle The handle of the geometry data object to fetch.

# Return value

Type: GeometryData

# GetItem

Returns the handle of the i:th item.

# Syntax

rhandle GetItem( unsigned int index );

# Parameters

Type Name Min Max Description
unsigned int index The index of an object in the collection.

# Return value

Type: rhandle

# GetItemAsObject

Returns the object of the i:th item.

# Syntax

spObject GetItemAsObject( unsigned int index );

# Parameters

Type Name Min Max Description
unsigned int index The index of an object in the collection.

# Return value

Type: Object

# GetItemCount

The number of items in the collection.

# Syntax

unsigned int GetItemCount();

# Parameters

GetItemCount takes no parameters.

# Return value

Type: unsigned int

# GetItemsObject

The object the handle is referring to.

# Syntax

spObject GetItemsObject( rhandle objhandle );

# Parameters

Type Name Min Max Description
rhandle objhandle The handle of an object in the collection.

# Return value

Type: Object

# GetNextItem

Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.

# Syntax

rhandle GetNextItem( rhandle objhandle );

# Parameters

Type Name Min Max Description
rhandle objhandle The handle of an object i.

# Return value

Type: rhandle

# GetNextItemAsGeometryData

Returns the object of the next item.

# Syntax

spGeometryData GetNextItemAsGeometryData( rhandle *phandle_rhandleInputDataPtr );

# Parameters

Type Name Min Max Description
RhandleData phandle The handle to the geometry object.

# Return value

Type: GeometryData

# IsA

Returns true if GeometryDataCollection is a or is a descendant of the class named as the type parameter.

# Syntax

bool IsA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if GeometryDataCollection is, or is a descendant of.

# Return value

Type: bool

# IsGeometryDataInCollection

Returns true if the object is in the collection.

# Syntax

bool IsGeometryDataInCollection( spGeometryData pobj );

# Parameters

Type Name Min Max Description
GeometryData pobj The GeometryData to look for.

# Return value

Type: bool

# IsItemInCollection

Returns true if the item is in the collection.

# Syntax

bool IsItemInCollection( rhandle objhandle );

# Parameters

Type Name Min Max Description
rhandle objhandle The handle of an object to be checked for.

# Return value

Type: bool

# IsNull

Returns true if the GeometryDataCollection object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsObjectInCollection

Returns true if the object is in the collection.

# Syntax

bool IsObjectInCollection( spObject pobj );

# Parameters

Type Name Min Max Description
Object pobj The object to be checked for.

# Return value

Type: bool

# RemoveAllItems

Removes all items from the collection.

# Syntax

void RemoveAllItems();

# Parameters

RemoveAllItems takes no parameters.

# RemoveGeometryData

Removes an object from the collection. Only the first occurrence of the object is removed.

# Syntax

void RemoveGeometryData( spGeometryData pobj );

# Parameters

Type Name Min Max Description
GeometryData pobj The GeometryData to remove from the collection.

# RemoveItem

Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.

# Syntax

rhandle RemoveItem( rhandle objhandle );

# Parameters

Type Name Min Max Description
rhandle objhandle The handle of the object that is to be removed.

# Return value

Type: rhandle

# RemoveObject

Removes an object from the collection. Only the first occurance of the object is removed from the collection.

# Syntax

void RemoveObject( spObject pobj );

# Parameters

Type Name Min Max Description
Object pobj The object that is to be removed.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

# Syntax

static bool IsClassA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCollection, and if this is the case, returns the object cast into spGeometryDataCollection.

# Syntax

static spGeometryDataCollection SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: GeometryDataCollection

← SceneNodeCollection →