#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IUnsignedShortArray:

Public Member Functions
virtual void	AddItem (unsigned short value)=0

virtual void	AddTuple (const unsigned short *tuple_ushortInputDataPtr)=0

virtual const char *	GetClass ()

virtual void	GetData (IUnsignedShortData *dest_param)=0

virtual void	GetDataRange (rid start_tuple_id, unsigned int tuple_count, IUnsignedShortData *dest_param)=0

virtual unsigned short	GetItem (rid id)=0

virtual void	GetTuple (rid id, IUnsignedShortData *dest_param)=0

virtual bool	IsA (const char *type) const

virtual void	SetData (const unsigned short *source_items_ushortInputDataPtr, unsigned int source_item_count)=0

virtual void	SetDataRange (rid start_tuple_id, const unsigned short *source_items_ushortInputDataPtr, unsigned int source_item_count)=0

virtual void	SetItem (rid id, unsigned short value)=0

virtual void	SetTuple (rid id, const unsigned short *tuple_ushortInputDataPtr)=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 IUnsignedShortArray *	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

IUnsignedShortArray is the ushort implementation of IValueArray. See IValueArray for a description.

Definition at line 4133 of file SimplygonSDK.h.

Member Function Documentation

◆ AddItem()

virtual void SimplygonSDK::IUnsignedShortArray::AddItem ( unsigned short value )

pure virtual

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

Parameters

value the value of the item.

◆ AddTuple()

virtual void SimplygonSDK::IUnsignedShortArray::AddTuple ( const unsigned short * tuple_ushortInputDataPtr )

pure virtual

Adds a tuple to the list. Reallocates the list if needed. If many items are 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

tuple_ushortInputDataPtr the value(s) of the tuple.

◆ GetClass()

virtual const char* SimplygonSDK::IUnsignedShortArray::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.

◆ GetData()

virtual void SimplygonSDK::IUnsignedShortArray::GetData ( IUnsignedShortData * dest_param )

pure virtual

Returns all tuples in the array as a single item array.

Parameters

dest_param pointer to allocated object to receive return value(s)

◆ GetDataRange()

virtual void SimplygonSDK::IUnsignedShortArray::GetDataRange	(	rid	start_tuple_id,
		unsigned int	tuple_count,
		IUnsignedShortData *	dest_param
	)

pure virtual

Returns a range of tuples in the array.

Parameters

start_tuple_id	the first id in the range. Value cannot be less than 0. Value cannot be greater than the value returned by GetMaxTupleId().
tuple_count	the number of tuples in the range.
dest_param	pointer to allocated object to receive return value(s)

◆ GetItem()

virtual unsigned short SimplygonSDK::IUnsignedShortArray::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. Value cannot be less than 0. Value cannot be greater than the value returned by GetMaxItemId().

◆ GetTuple()

virtual void SimplygonSDK::IUnsignedShortArray::GetTuple	(	rid	id,
		IUnsignedShortData *	dest_param
	)

pure virtual

Gets a tuple in the list. The id is the id of the tuple that is being fetched. Warning! No range checking is done.

Parameters

id	the id of the tuple. Value cannot be less than 0. Value cannot be greater than the value returned by GetMaxTupleId().
dest_param	pointer to allocated object to receive return value(s)

◆ IsA()

virtual bool SimplygonSDK::IUnsignedShortArray::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::IUnsignedShortArray::IsClassA ( const char * type )

inlinestatic

The IsClassA function returns true if IUnsignedShortArray 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 4154 of file SimplygonSDK.h.

◆ SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IUnsignedShortArray pointer

Returns: a pointer to the IUnsignedShortArray object, if the cast can be made, and a NULL pointer otherwise

Definition at line 4167 of file SimplygonSDK.h.

◆ SetData()

virtual void SimplygonSDK::IUnsignedShortArray::SetData	(	const unsigned short *	source_items_ushortInputDataPtr,
		unsigned int	source_item_count
	)

pure virtual

Set the array from a range of data values. Note that the array will be resized to the size of the items. Note that the source_item_count is the number of items to set, NOT the number of tuples.

Parameters

source_items_ushortInputDataPtr	the array to copy from. Value cannot be equal to null.
source_item_count	the number of items in the array.

◆ SetDataRange()

virtual void SimplygonSDK::IUnsignedShortArray::SetDataRange	(	rid	start_tuple_id,
		const unsigned short *	source_items_ushortInputDataPtr,
		unsigned int	source_item_count
	)

pure virtual

Set a part of the array from a range of data values. Note that the array will be resized to contain the size of the items. Note that the source_item_count is the number of items to set, NOT the number of tuples, but start_tuple_id IS the first tuple index to update.

Parameters

start_tuple_id	where to start copy to in this array. Value cannot be less than 0. Value cannot be greater than the value returned by GetMaxTupleId().
source_items_ushortInputDataPtr	the array to copy from. Value cannot be equal to null.
source_item_count	the number of items in the array.

◆ SetItem()

virtual void SimplygonSDK::IUnsignedShortArray::SetItem	(	rid	id,
		unsigned short	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 cannot be less than 0. Value cannot be greater than the value returned by GetMaxItemId().
value	the new value of the item.

◆ SetTuple()

virtual void SimplygonSDK::IUnsignedShortArray::SetTuple	(	rid	id,
		const unsigned short *	tuple_ushortInputDataPtr
	)

pure virtual

Sets a tuple in the list. The id is the id of the tuple that is being updated. Warning! No range checking is done in release mode.

Parameters

id	the id of the tuple. Value cannot be less than 0. Value cannot be greater than the value returned by GetMaxTupleId().
tuple_ushortInputDataPtr	the new value(s) of the tuple.

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

SimplygonSDK.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddItem()

◆ AddTuple()

◆ GetClass()

◆ GetData()

◆ GetDataRange()

◆ GetItem()

◆ GetTuple()

◆ IsA()

◆ IsClassA()

◆ SafeCast()

◆ SetData()

◆ SetDataRange()

◆ SetItem()

◆ SetTuple()