MM Developer's Guide
MM Interfaces | MM Methods | MM Types and Misc API
Interface ID: IID_IMoaMmXSpriteActor
Pointer type:
PIMoaMmXSpriteActor
Inheritance: IMoaMmPropOwner
Header file: mmixasst.h
IMoaMmXSpriteActor
interface lets an asset Xtra implement
runtime behavior for presenting during playback of a multimedia
piece. The methods of this interface enable asset Xtras to describe
their capabilities to an application, to draw themselves, to handle
events, and to interact with their asset and the application.
- CallFunction(PIMoaMmXSpriteActorThis,
- MoaMmSymbolmethodName,
MoaLongnArgs,
ConstPMoaMmValuepArgs,
PMoaMmValuepResult)
This
IMoaMmXSpriteActor
interfacemethodName
MoaMmSymbol
Symbol of the method (function) to
call nArgs
MoaLong
Number of arguments, excluding reserved
value in pArgs[0] pArgs
ConstPMoaMmValue
Array of arguments, with the
first valid argument at pArgs[1] pResult
PMoaMmValue
tt>Pointer to a MoaMmValue to receive a result value, if any kMoaErr_NoErr | Function exists and operation was successful |
kMoaErr_BadParam | Invalid nArgs, pArgs, or pResult passed in |
kMoaMmErr_FunctionNotFound | Function not supported by this actor |
kMoaErr_OutOfMem | Couldn't allocate memory needed to execute function |
kMoaMmErr_InternalError | Function exists, args ok, can't execute internal error |
kMoaMmErr_NoArgExpected | Wrong number of args: 0 expected |
kMoaMmErr_OneArgExpected | Wrong number of args: 1 expected |
kMoaMmErr_TwoArgsExpected | Wrong number of args: 2 expected |
kMoaMmErr_ThreeArgsExpected | Wrong number of args: 3 expected |
kMoaMmErr_FourArgsExpected | Wrong number of args: 4 expected |
kMoaMmErr_WrongNumberOfArgs | Wrong number of arguments, non- specific |
kMoaMmErr_IntegerExpected | Type mismatch: integer value argument expected |
kMoaMmErr_SymbolExpected | Type mismatch: symbol value argument expected |
kMoaMmErr_FloatExpected | Type mismatch: float value argument expected |
kMoaMmErr_StringExpected | Type mismatch: string value argument expected |
kMoaMmErr_PointExpected | Type mismatch: point value argument expected |
kMoaMmErr_RectExpected | Type mismatch: rect value argument expected |
kMoaMmErr_ValueTypeMismatch | Type mismatch: other value argument expected |
kMoaDrErr_CastMemberExpected | Type mismatch: CMRef value argument expected (Director only) |
- CollectChanges(PIMoaMmXSpriteActorThis,
- ConstPMoaMmXSpriteInfopActorInfo,
PIMoaMmChangeCollectorpChangeCollector)
This
IMoaMmXSpriteActor
interfacepActorInfo
ConstPMoaMmXSpriteInfo
Pointer to an ActorInfo structure for context in which actor is imaged pChangeCollector
PIMoaMmChangeCollector
Pointer to an IMoaMmChangeCollector interface kMoaErr_NoErr | Successful, change rects (if any) submitted |
kMoaMmErr_NotImplemented | Sprite is static, updates are requested using InvalSpriteRect(). You must set the kMoaMmXSpriteCapsFlags_IsStatic sprite caps flag in your GetCaps(). |
- ContainsPoint(PIMoaMmXSpriteActorThis,
- ConstPMoaMmXSpriteInfopActorInfo,
ConstPMoaPointpTestPoint,
MoaBoolParam FAR *pTestResult)
This
IMoaMmXSpriteActor
interfacepActorInfo
ConstPMoaMmXSpriteInfo
Pointer to MoaMmXSpriteInfo for context in which actor draw pTestPoint
ConstPMoaPoint
Pointer to the point to test pTestResult
MoaBoolParam FAR *
Pointer to MoaLong for result: 0 if not within, non-0 if within kMoaErr_NoErr | Successful, pTestResult set |
- Event(PIMoaMmXSpriteActorThis,
- ConstPMoaMmEventInfopEventInfo,
ConstPMoaMmPlayerStateInfopPlayerStateInfo,
MoaBoolParam FAR *pHandled)
This
IMoaMmXSpriteActor
interfacepEventInfo
ConstPMoaMmEventInfo
Pointer to a MoaMmEventInfo structure containing information about the event pPlayerStateInfo
ConstPMoaMmPlayerStateInfo
Pointer to a caller-owned
structure containing various state information about the player pHandled
MoaBoolParam FAR *
Pointer to a MoaLong to receive the handled status of the event; 0 if the
event is to be passed along (not handled), or non-0 if the actor
absorbed the event. kMoaErr_NoErr | Successful, event handled or intentionally passed |
kMoaErr_OutOfMem | Wanted event but couldn't handle due to memory error |
kMoaMmErr_InternalError | Wanted event but couldn't handle due to an internal error |
- GetCaps(PIMoaMmXSpriteActorThis,
- PMoaMmXSpriteCapspActorCaps)
This
IMoaMmXSpriteActor
interfacepActorCaps
PMoaMmXSpriteCaps
Pointer to a MoaMmXSpriteCaps structure to receive actor capabilities kMoaErr_NoErr | Successful |
- GetProp(PIMoaMmXSpriteActorThis,
- MoaMmSymbolsymbol,
PMoaMmValuepPropValue)
This
IMoaMmXSpriteActor
interfacesymbol
MoaMmSymbol
MoaMmSymbol representing the requested property pPropValue
PMoaMmValue
Pointer to a MoaMmValue to receive the value kMoaErr_NoErr | Property exists and value was returned |
kMoaErr_BadParam | Invalid pPropValue passed in |
kMoaMmErr_PropertyNotFound | Property isn't supported by this actor |
kMoaMmErr_InternalError | Property exists but couldn't get due to internal error |
kMoaMmErr_NoMemForString | Couldn't allocate memory for string value data |
kMoaErr_OutOfMem | Couldn't allocate memory for other value data |
- Image(PIMoaMmXSpriteActorThis,
- ConstPMoaMmXSpriteInfopActorInfo,
ConstPMoaMmPlayerStateInfopPlayerStateInfo,
PIMoaMmGCpGC)
This
IMoaMmXSpriteActor
interfacepActorInfo
ConstPMoaMmXSpriteInfo
Pointer to MoaMmXSpriteInfo structure for context in which actor is drawn pPlayerStateInfo
ConstPMoaMmPlayerStateInfo
Pointer to a caller-owned CMoaMmPlayerStateInfo structure
containing state information about the player pGC
PIMoaMmGC
Pointer to an IMoaMmGC interface for the graphics context into which the
sprite actor should be imaged kMoaErr_NoErr | Successful, sprite imaged into supplied GC |
kMoaMmErr_NotImplemented | Actor doesn't have a visual representation |
kMoaMmErr_GCTypeNotSupported | Doesn't support supplied GC type |
kMoaErr_OutOfMem | Couldn't image due to memory error |
kMoaMmErr_InternalError | Couldn't image due to an internal error |
- Notify(PIMoaMmXSpriteActorThis,
- MoaLongmsgCode,
PMoaVoidrefCon)
This
IMoaMmXSpriteActor
interfacemsgCode
refCon
kMoaErr_NoErr | Successful |
kMoaMmErr_UnknownNotifyMsgCode | Notify message code not supported Used for communicating between assets and their actors. The NotifySprites() method of the IMoaMmAssetCallback interface calls this method for all active sprite actors. |
- SetCallback(PIMoaMmXSpriteActorThis,
- PIMoaMmSpriteCallbackpSpriteCallback)
This
IMoaMmXSpriteActor
interfacepSpriteCallback
PIMoaMmSpriteCallback
Pointer to an instance of
the IMoaMmSpriteCallback interface kMoaErr_NoErr | Interface set |
kMoaMmErr_NotImplemented | Callback interface not used |
- SetProp(PIMoaMmXSpriteActorThis,
- MoaMmSymbolsymbol,
ConstPMoaMmValuepPropValue)
This
IMoaMmXSpriteActor
interfacesymbol
MoaMmSymbol
MoaMmSymbol representing the property
to set pPropValue
ConstPMoaMmValue
Pointer to a ConstPMoaMmValue which contains the value kMoaErr_NoErr | Property exists and value was set |
kMoaErr_BadParam | Invalid pPropValue passed in |
kMoaMmErr_PropertyNotFound | Property isn't supported by this class |
kMoaMmErr_InternalError | Property exists, value ok, can't set due to internal error |
kMoaMmErr_NoMemForString | Can't allocate memory for setting string value data |
kMoaErr_OutOfMem | Can't allocate memory for setting other value data |
kMoaMmErr_IntegerExpected | Type mismatch: integer value expected |
kMoaMmErr_SymbolExpected | Type mismatch: symbol value expected |
kMoaMmErr_FloatExpected | Type mismatch: float value expected |
kMoaMmErr_StringExpected | Type mismatch: string value expected |
kMoaMmErr_PointExpected | Type mismatch: point value expected |
kMoaMmErr_RectExpected | Type mismatch: rect value expected |
kMoaMmErr_ValueTypeMismatch | Type mismatch: other value expected (non-specific) |
kMoaDrErr_CastMemberExpected | Type mismatch: CMRef expected (Director only) |