Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

Rt2dCel
[Rt2dAnim (inc. Maestro)]


Data Structures
struct   Rt2dCel
struct   Rt2dCelList

Functions
Rt2dCel *  Rt2dCelCreate (Rt2dMaestro *maestro, const RwChar *name, RwInt32 celIndex, RwInt32 messageListIndex)
RwBool  Rt2dCelDestroy (Rt2dMaestro *maestro, Rt2dCel *cel)
Rt2dCel *  Rt2dCelAddButtonIndex (Rt2dCel *cel, RwInt32 buttonIndex, RwInt32 *index)
RwInt32  Rt2dCelGetStringLabelIndex (Rt2dCel *cel)
void  Rt2dCelSetStringLabelIndex (Rt2dCel *cel, RwInt32 index)
RwInt32  Rt2dCelGetCelIndex (Rt2dCel *cel)
void  Rt2dCelSetCelIndex (Rt2dCel *cel, RwInt32 index)
RwInt32  Rt2dCelGetMessageListIndex (Rt2dCel *cel)
void  Rt2dCelSetMessageListIndex (Rt2dCel *cel, RwInt32 index)
Rt2dCelList *  Rt2dCelListCreate (void)
RwBool  Rt2dCelListDestroy (Rt2dCelList *celList)
Rt2dCelList *  Rt2dCelListLock (Rt2dCelList *celList)
Rt2dCelList *  Rt2dCelListUnlock (Rt2dCelList *celList)
Rt2dCelList *  Rt2dCelListCopy (Rt2dCelList *srcCelList)
Rt2dCelList *  Rt2dCelListAddCel (Rt2dCelList *celList, Rt2dCel *cel, RwInt32 *index)
Rt2dCelList *  Rt2dCelListCelGetStringLabelIndex (Rt2dCelList *celList, RwInt32 celIndex, RwInt32 *index)
Rt2dCelList *  Rt2dCelListCelButtonGetDisplayVersion (Rt2dMaestro *maestro, Rt2dCelList *celList, RwInt32 celIndex, RwInt32 celButtonIndex, RwInt32 *index)
Rt2dCelList *  Rt2dMaestroGetCelListByIndex (Rt2dMaestro *maestro, RwInt32 index)

Detailed Description

Cels

Function Documentation

Rt2dCel* Rt2dCelAddButtonIndex (  Rt2dCel *    cel,
RwInt32    buttonIndex,
RwInt32 *    index
) 
 

Rt2dCelAddButtonIndex is used to assign a button's index to the cel. The index is the index in the maestro.

Each cel can have a number of buttons associated with it. These buttons are stored in the maestro and is referenced by its index. Each button in a cel also have another index, local to the cel. This is the index of the button within the cel.

The button's index in the cel is returned if index is not NULL.

Parameters:
cel  Pointer to the cel.
buttonIndex  Index of the button in the maestro.
index  Pointer to a RwInt32 to return the button's index in the cel.
Returns:
Returns a pointer to the cel if successful, NULL otherwise.
See also:
Rt2dCelCreate , Rt2dMaestroAddButton
Rt2dCel* Rt2dCelCreate (  Rt2dMaestro *    maestro,
const RwChar *    name,
RwInt32    celIndex,
RwInt32    messageListIndex
) 
 

Rt2dCelCreate creates a new empty cel. The name will be added to the maestro's label table with entity type of rt2dANIMLABELTYPEFRAME. If a label entry already exists in the maestro, then the new cel will not be created.

Parameters:
maestro  Pointer to the parent maestro.
name  Name of the new cel.
celIndex  Index of the cel.
messageListIndex  Index to list of messages for the cel.
Returns:
Returns a pointer to the new cel if successful, NULL otherwise.
See also:
Rt2dCelDestroy
RwBool Rt2dCelDestroy (  Rt2dMaestro *    maestro,
Rt2dCel *    cel
) 
 

Rt2dCelDestroy is called to destroy a cel. The cel's label in the maestro is not destroyed however.

Only cels created with Rt2dCelCreate can be destroyed. Other cels cannot be destroyed this way because they form part of an integral data structure.

Parameters:
maestro  Pointer to the parent maestro.
cel  Pointer to cel to be destroyed.
Returns:
Returns TRUE if successful, FALSE otherwise.
See also:
Rt2dCelCreate
RwInt32 Rt2dCelGetCelIndex (  Rt2dCel *    cel ) 
 

Rt2dCelGetCelIndex is used to retrieve the cel's index.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

Parameters:
cel  Pointer to the cel.
Returns:
Returns the cel's index if successful, -1 otherwise.
See also:
Rt2dCelCreate , Rt2dCelSetCelIndex
RwInt32 Rt2dCelGetMessageListIndex (  Rt2dCel *    cel ) 
 

Rt2dCelGetMessageListIndex is used to retrieve the cel's message list index. This index should be the index returned by Rt2dMaestroAddMessageList.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

Parameters:
cel  Pointer to the cel.
Returns:
Returns the cel's message list index, -1 otherwise.
See also:
Rt2dCelCreate , Rt2dCelSetMessageListIndex , Rt2dMaestroAddMessageList
RwInt32 Rt2dCelGetStringLabelIndex (  Rt2dCel *    cel ) 
 

Rt2dCelGetStringLabelIndex is used to return the label's index. This is an index into the cel's parent maestro's label table. The label is used for cel identification.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

Parameters:
cel  Pointer to the cel.
Returns:
Returns the label's index if successful, -1 otherwise.
See also:
Rt2dCelCreate , Rt2dCelSetStringLabelIndex , Rt2dMaestroAddStringLabel
Rt2dCelList* Rt2dCelListAddCel (  Rt2dCelList *    celList,
Rt2dCel *    cel,
RwInt32 *    index
) 
 

Rt2dCelListAddCel is used add a cel to the cel list. A new cel in the cel list is created and the given cel is copied into it. The given cel is not referenced by the new cel or the cel list.

The cel list must be locked before a new cel can be added.

Parameters:
celList  Pointer to the parent cel list.
cel  Pointer to the cel to be added.
index  Pointer to a RwInt32 to return the cel's index.
Returns:
Returns a pointer to the cel list if successful, NULL otherwise.
See also:
Rt2dCelCreate , Rt2dCelListCreate , Rt2dCelListDestroy , Rt2dCelListLock , Rt2dCelListUnlock
Rt2dCelList* Rt2dCelListCelButtonGetDisplayVersion (  Rt2dMaestro *    maestro,
Rt2dCelList *    celList,
RwInt32    celIndex,
RwInt32    celButtonIndex,
RwInt32 *    index
) 
 

Rt2dCelListCelButtonGetDisplayVersion is used to retrieve the cel's button's label index.

Parameters:
maestro  Pointer to parent maestro.
celList  Pointer to the parent cel list.
celIndex  Cel's index.
celButtonIndex  Cel's button index.
index  Pointer to a RwInt32 to return the cel's button's label index.
Returns:
Returns a pointer to the cel list if successful, NULL otherwise.
See also:
Rt2dCelAddButtonIndex , Rt2dCelListAddCel
Rt2dCelList* Rt2dCelListCelGetStringLabelIndex (  Rt2dCelList *    celList,
RwInt32    celIndex,
RwInt32 *    index
) 
 

Rt2dCelListCelGetStringLabelIndex is used to retrieve the cel's label index

Parameters:
celList  Pointer to the parent cel list.
celIndex  Pointer to the cel index to be added.
index  Pointer to a RwInt32 to return the cel's index.
Returns:
Returns a pointer to the cel list if successful, NULL otherwise.
See also:
Rt2dCelCreate , Rt2dCelListAddCel
Rt2dCelList* Rt2dCelListCopy (  Rt2dCelList *    srcCelList ) 
 

Rt2dCelListCopy is used to duplicate an existing cel list. Cels within the cel list are also duplicated, not referenced. Indexed data, such as buttons, are not copied, but the indices are. Thus a copied cel will share the same indexed data as the original cel.

Parameters:
srcCelList  Pointer to a cel list to be copied.
Returns:
Returns a pointer to the new cel list if successful, NULL otherwise.
See also:
Rt2dCelListLock
Rt2dCelList* Rt2dCelListCreate (  void    ) 
 

Rt2dCelListCreate creates a new empty cellist.

Returns:
Returns a pointer to a cel list if successful, NULL otherwise.
See also:
Rt2dCelListDestroy
RwBool Rt2dCelListDestroy (  Rt2dCelList *    celList ) 
 

Rt2dCelListDestroy destroys a cel list and all its contents. Any cels in cel list are also destroyed.

Parameters:
celList  Pointer to the cellist to be destroyed.
Returns:
Returns TRUE if successful, FALSE otherwise.
See also:
Rt2dCelListCreate
Rt2dCelList* Rt2dCelListLock (  Rt2dCelList *    celList ) 
 

Rt2dCelListLock is used to lock a cel list. A cel list must be locked before any modifcations can be made and unlocked afterwards. Cel lists needs to be in the unlocked form during playback.

A cel list can only be locked once. Attempts to lock a locked cel list will do nothing.

Parameters:
celList  Pointer to cel list to be locked.
Returns:
Returns a pointer to the cel list if successful, NULL otherwise.
See also:
Rt2dCelListUnlock
Rt2dCelList* Rt2dCelListUnlock (  Rt2dCelList *    celList ) 
 

Rt2dCelListUnlock is used to unlock a locked cel list. A cel lists must be unlocked during playback.

Only locked list can be unlocked. Attempts to unlock an unlocked cel list will do nothing.

Parameters:
celList  Pointer to a cellist to be unlocked.
Returns:
Returns a pointer to the cel list if successful, NULL otherwise.
See also:
Rt2dCelListLock
void Rt2dCelSetCelIndex (  Rt2dCel *    cel,
RwInt32    index
) 
 

Rt2dCelSetCelIndex is used to set the cel's index.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

Parameters:
cel  Pointer to the cel
index  Cel index
See also:
Rt2dCelCreate , Rt2dCelSetCelIndex
void Rt2dCelSetMessageListIndex (  Rt2dCel *    cel,
RwInt32    index
) 
 

Rt2dCelSetMessageListIndex is used to set the cel's message list index. This index should be the index returned by Rt2dMaestroAddMessageList.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

Parameters:
cel  Pointer to the cel.
index  Message list index.
See also:
Rt2dCelCreate , Rt2dCelGetMessageListIndex , Rt2dMaestroAddMessageList
void Rt2dCelSetStringLabelIndex (  Rt2dCel *    cel,
RwInt32    index
) 
 

Rt2dCelSetStringLabelIndex is used to set a cel's label index. This is an index into the cel's parent maestro's label table. The label is used for cel identification.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for final release versions of an application.

Parameters:
cel  Pointer to the cel.
index  Label index.
See also:
Rt2dCelCreate , Rt2dCelGetStringLabelIndex , Rt2dMaestroAddStringLabel , Rt2dMaestroGetStringLabelByIndex
Rt2dCelList* Rt2dMaestroGetCelListByIndex (  Rt2dMaestro *    maestro,
RwInt32    index
) 
 

Rt2dMaestroGetCelListByIndex is used to retrieve the maestro's cel list given by index. This is the index returned by Rt2dMaestroAddAnimations.

Parameters:
maestro  Pointer to parent maestro.
index  Cel list's index in the maestro.
Returns:
Returns a pointer to the cel list if successful, NULL otherwise.
See also:
Rt2dMaestroAddAnimations , Rt2dMaestroGetAnimationsByIndex , Rt2dMaestroGetAnimPropsByIndex , Rt2dMaestroGetAnimSceneByIndex
Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:51 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)