SAA_cusOperatorRemoveFcurveCallback
[ Home ] [ Sales ] [ Products ] [ Services ] [ Support ] [ Downloads ]

SAA_cusOperatorRemoveFcurveCallback

Removes a callback from an OAT function curve.

set scene [SAA_AllocScene]

set icon [SAA_AllocElem] # or NULL

.

.

.


set OATname "symbol_name_from_cus_file"

set context [SAA_AllocCustomContext]

set command tcl_command_line_to_eval

SAA_cusOperatorAddFcurveCallback  $scene $icon $OATname CustomContext1 $command handleName 

.

.

SAA_cusOperatorRemoveFcurveCallback  $scene $icon OATname $context $handleName

icon

Icon for the effect. Use SAA_customContextGetIcon.

This argument is required only if you are removing a callback from an OAT of another effect. Otherwise, icon can be NULL.

OATname

Symbol name declared in the .cus file for the operator attribute.

context

Custom context of the effect that added the callback.

handleName

this is the handle which was returned when the callback was created by SAA_cusOperatorAddFcurveCallback.

Return Value

Return correct usage if incorrect parameters are passed
"SI_ERR_BAD_ARGUMENT" if a pointer argument is NULL or there is no such OAT.

"SI_ERR_NOTSUPPORTED" if you try to:

• Remove a callback from an effect in another scene.
• Remove a callback from an immediate effect.

Notes

This signature differs from the C language SDK signature in that one specifies the callback to remobve by it's handle and the cbd parametere is not needed and is therefore omitted.

The SoftWish procedure SAA_cusOperatorRemoveFcurveCallback differs from the corresponding SAAPHIRE C language routine in because SoftWish tracks callbacks by handles. To remove a callback in SoftWish you specify it's handle. Here are the signatures of the SoftWish and SAAPHIRE versions of SAA_cusOperatorRemoveFcurveCallback:

SoftWish - Tcl:

SAA_cusOperatorRemoveFcurveCallback

{
const SAA_Scene *scene
const SAA_Elem *icon
const char *OATname
const SAA_CustomContext context
const char * handleName
}

SAAPHIRE - C:

SI_Error SAA_cusOperatorRemoveFcurveCallback

(
const SAA_Scene *scene,
const SAA_Elem *icon,
const char *OATname,
const SAA_CustomContext context,
SAA_CusOperatorCallback func,
void *cbd
);

SoftWish custom operator callbacks example

[ SAA Index ] [ Examples SAA calls index ]

copyright Video-Collage Inc.