MM Developer's Guide
MM Interfaces | MM Methods | MM Types and Misc API


IMoa3dVectorValueUtils

Interface ID: IID_IMoa3dVectorValueUtils
Pointer type: PIMoa3dVectorValueUtils
Inheritance: IMoaUnknown
Header file: mivect3d.h

Description

This callback interface provides support for converting between the 3D vector type (new to Director 8.5) and the MoaMmValue type. The vector type is defined in m3dtypes.h

Methods

Data conversion

ValueToMoa3dVector()
ValueToMoa3dVectorPtr()
ValueReleaseVectorPtr()
Moa3dVectorToValue()

ValueToMoa3dMatrix()
Moa3dMatrixToValue()

Value type checking

ValueIsAVector()
ValueIsATransform()

ValueToMoa3dVector()

Syntax

ValueToMoa3dVector(ConstPMoaMmValue pValue, Moa3dVector pVector)

Parameters

pValue
Pointer to a MmValue that contains the vector value
pVector
Pointer to the Moa3dVector that will receive the result

Returns

MoaError

Description

Obtains the Moa3dVector data for a value with type kMoaMmValueType_3dVector. pVector is a pointer to memory for a Moa3dVector to receive the result. Returns kMoaMmErr_VectorValueExpected if pValue is not a vector-type value.

ValueToMoa3dVectorPtr()

Syntax

ValueToMoa3dVectorPtr(ConstPMoaMmValue pValue, Moa3dVector ** ppVector)

Parameters

pValue
Pointer to a MmValue
ppVector
returns a pointer to a Moa3dVector rather than a copy

Returns

MoaError

Description

Like ValueToMoa3dVector, except that it returns a ptr to the Moa3dVector this value represents, rather than a copy. Locks any necessary handles. Caller is responsible for calling ValueReleaseVectorPtr when they are done with it. Returns kMoaMmErr_VectorValueExpected if pValue is not a vector-type value.


ValueReleaseVectorPtr()

Syntax

ValueReleaseVectorPtr(ConstPMoaMmValue pValue, Moa3dVector ** ppVector)

Parameters

pValue
Pointer to a MoaMmValue with the value of interest
ppVector
Pointer to a memory location with a pointer to a Moa3dVector

Returns

MoaError

Description

Unlocks any handle associated with a previous call to ValueToMoa3dVectorPtr. Should be preceeded by a call to ValueToMoa3dVectorPtr

Moa3dVectorToValue()

Syntax

Moa3dVectorToValue(Moa3dVector pVector, PMoaMmValue pValue)

Parameters

pVector
pointer to the Moa3dVector that contains the vector data
pValue
Pointer to a MoaMmValue to receive the result

Returns

MoaError

Description

Converts a Moa3dVector into a Lingo value, the caller must ValueRelease when done with it

ValueToMoa3dMatrix()

Syntax

ValueToMoa3dMatrix(ConstPMoaMmValue pValue, Moa3dMatrix pMatrix)

Parameters

pValue
Pointer to a MmValue that contains the matrix value
pMatrix
Pointer to the Moa3dMatrix that will receive the result

Returns

MoaError

Description

Obtains the Moa3dMatrix data for a value. pMatrix is a pointer to memory for a Moa3dMatrix to receive the result. Returns kMoaMmErr_MatrixValueExpected if pValue is not of type kMoaMmValueType_3dMatrix.

Moa3dMatrixToValue()

Syntax

Moa3dMatrixToValue(Moa3dMatrix pMatrix, PMoaMmValue pValue)

Parameters

pMatrix
Pointer to the Moa3dMatrix that contains the matrix value
pValue
Pointer to a MmValue that will receive the value for the matrix data

Returns

MoaError

Description

Converts data in a Moa3dMatrix data to a value. pMatrix is a pointer to memory for a Moa3dMatrix that contains the matrix values. This interface is only supported with Director 8.5.1 and later. Note that some matrix data is not valid or useful as a 3D transform matrix.

ValueIsAVector()

Syntax

ValueIsAVector(ConstPMoaMmValue pValue)

Parameters

pValue
Pointer to a MoaMmValue

Returns

MoaLong

Description

returns 1 if the value is a moa3dVector, 0 if not

ValueIsATransform()

Syntax

ValueIsATransform(ConstPMoaMmValue pValue)

Parameters

pValue
Pointer to a MoaMmValue

Returns

MoaLong

Description

returns 1 if the value is a moa3dMatrix, 0 if not

Copyright © 2001-2008 Adobe Macromedia Software LLC, Inc.