Independent Software Solutions 

CONTENTS

  CSM GROUP TO PIVOT


Functions

Synopsis

return CSM GROUP TO PIVOT( group index As Integer ) As Integer

Purpose

This function will return the pivot specified by the group index, if it exists.  When designing your maps which use pivots, ALL pivot entities will be contained in their own groups.  This function can be used to obtain the pivot ID directly associated with it's group and therefore perform pivot operations on a group very quickly.

Parameters

group index

Specifies a group index >=0 and <total.  Use the CSM COUNT function to obtain the total number for a specific type.

Return value

Returns the pivot identifier that the specified group belongs to.

Also see

CSM OBJECT TO GROUP, CSM GROUP TO OBJECT,
CSM ENTITY TO GROUP, CSM MESH TO GROUP,
CSM PIVOT TO GROUP

 

(C) Paul S. J. Millard 2006