SimplygonSDK::IStringArray Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IStringArray:

Public Member Functions
virtual void	AddItem (const char *value)=0
virtual const char *	GetClass ()
virtual rstring	GetItem (rid id)=0
virtual bool	IsA (const char *type) const
virtual void	SetItem (rid id, const char *value)=0
Public Member Functions inherited from SimplygonSDK::IValueArray
virtual SGDEPRECATED void	CopyCombine3Tuples (IValueArray *sourceArray, rid dest_id, rid src_id_1, rid src_id_2, rid src_id_3, real alpha_1, real alpha_2)=0
virtual SGDEPRECATED void	CopyCombineTuples (IValueArray *sourceArray, rid dest_id, rid src_id_1, rid src_id_2, real alpha)=0
virtual SGDEPRECATED bool	GetInterpolateTuples ()=0
virtual real	GetRealItem (rid id)=0
virtual SGDEPRECATED void	IndexedCombine (IValueArray *source, IRidArray *idtable, IRealArray *blendtable, rid startId)=0
virtual SGDEPRECATED void	IndexedCombine3 (IValueArray *source, IRidArray *idtable, IRealArray *blendtable, rid startId)=0
virtual SGDEPRECATED void	SetInterpolateTuples (bool value)=0
virtual void	SetRealItem (rid id, real value)=0
Public Member Functions inherited from SimplygonSDK::IArray
virtual void	AppendArray (IArray *source)=0
virtual SGDEPRECATED void	AppendTuples (IArray *source)=0
virtual void	Clear ()=0
virtual int	CompareTuples (IArray *otherArray, rid tuple_id, rid other_tuple_id)=0
virtual void	CopyRange (IArray *source_array, rid start_dest_id, rid start_src_id, unsigned int count)=0
virtual void	CopyTuple (IArray *sourceArray, rid dest_id, rid src_id)=0
virtual void	DeepCopy (IArray *source)=0
virtual void	ExtractTuples (IArray *dest, rid start, unsigned int count)=0
virtual rstring	GetAlternativeName ()=0
virtual rid	GetBaseType ()=0
virtual unsigned int	GetItemCount ()=0
virtual rid	GetMaxItemId ()=0
virtual rid	GetMaxTupleId ()=0
virtual unsigned int	GetTupleCount ()=0
virtual unsigned int	GetTupleSize ()=0
virtual void	IndexedCopy (IArray *source, IRidArray *idtable, rid startId)=0
virtual bool	IsEmpty ()=0
virtual CountedPointer< IArray >	NewCopy (bool copy_data)=0
virtual CountedPointer< IArray >	NewPackedCopy (IRidArray *index_array)=0
virtual void	SetAlternativeName (const char *value)=0
virtual void	SetItemCount (unsigned int count)=0
virtual void	SetTupleCount (unsigned int tuplecount)=0
virtual void	SetTupleSize (unsigned int newsize)=0
Public Member Functions inherited from SimplygonSDK::IObject
virtual rid	AddObserver (robserver *Observer, rid EventId)=0
virtual void	AddRef ()=0
virtual rstring	GetName ()=0
virtual void *	GetUserComponentArea (rid userid)=0
virtual void	PrintInfo ()=0
virtual void	Release ()=0
virtual void	RemoveObserver (rid ObserverId)=0
virtual void	SetName (const char *Name)=0

Static Public Member Functions
static bool	IsClassA (const char *type)
static IStringArray *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IValueArray
static bool	IsClassA (const char *type)
static IValueArray *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IArray
static bool	IsClassA (const char *type)
static IArray *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

Deprecated:

Interface is marked as deprecated and will be removed in future version. Deprecated interface, which will be removed in version 9.0. ReStringArray is the string implementation of ReValueArray. See ReValueArray for a description. Please note that conversions to/from real values will not work on string arrays.

Definition at line 2251 of file SimplygonSDK.h.

Member Function Documentation

AddItem()

virtual void SimplygonSDK::IStringArray::AddItem ( const char *  value )

pure virtual

Adds an item to the list, allocates memory as needed to enlarge the list. If many items is being put into the list, use Resize to set the size of the new list (only one reallocation needed) and then use SetItem / SetRealTuple to set the items directly.

Parameters

value

the value of the item

GetClass()

virtual const char* SimplygonSDK::IStringArray::GetClass ( )

virtual

GetClass returns the name of the class of the object.

Returns

the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::IValueArray.

GetItem()

virtual rstring SimplygonSDK::IStringArray::GetItem ( rid  id )

pure virtual

Gets the value of an item in the list. The id of the item is the exact location of the item (TupleId * TupleSize + Index of item in tuple) Warning! No range checking is done in release mode.

Parameters

id	the id of the item

IsA()

virtual bool SimplygonSDK::IStringArray::IsA ( const char *  type ) const

virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the object is, or is a descendant of

Returns

true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::IValueArray.

IsClassA()

static bool SimplygonSDK::IStringArray::IsClassA ( const char *  type )

inlinestatic

The IsClassA function returns true if IStringArray is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the class is, or is a descendant of

Returns

true if the class is of the specified class, false if not

Definition at line 2272 of file SimplygonSDK.h.

SafeCast()

static IStringArray* SimplygonSDK::IStringArray::SafeCast ( IObject *  ptr )

inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a IStringArray pointer, and if this is possible, returns the cast pointer.

Parameters

ptr	is the pointer to be cast into a IStringArray pointer

Returns

a pointer to the IStringArray object, if the cast can be made, and a NULL pointer otherwise

Definition at line 2285 of file SimplygonSDK.h.

SetItem()

virtual void SimplygonSDK::IStringArray::SetItem ( rid  id, const char *  value  )

pure virtual

Sets an item in the list. The id of the item is the exact location of the item (TupleId * TupleSize + Index of item in tuple) Warning! No range checking is done in release mode.

Parameters

id	the id of the item
value	the new value of the item

---

The documentation for this class was generated from the following file:

• SimplygonSDK.h