IDXEffect Interface

IID_IDXEffect

{E31FB81B-1335-11D1-8189-0000F87557DB}

This interface generically controls transition settings on all transform objects.

Remarks

Transitions often produce animated images from static images. There could be other animation properties that the transform needs to produce its output. In this case, you should add these properties to the transform custom interface.

There are two variables that control the development of the effect. The IDXEffect::Progress variable is a number from 0.0 to 1.0 that controls the percentage of the transition to complete. Animation effects are often produced by looping over increasing values for IDXEffect::Progress, producing transform output at each step.

The IDXEffect::get_Duration variable is a suggested time, in seconds, that such a stepwise transition should take. In general, it only provides storage of the time value, and has no control over the transform output. It is up to the transform user to see that the transition over IDXEffect::Progress values happens in the suggested time.

This interface inherits from the IDispatch interface.
 

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDispatch Methods

Description

GetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

GetTypeInfo

Gets the type information for an object.

GetIDsOfNames

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs.

Invoke

Provides access to properties and methods exposed by an object.

IDXEffect Members

Description

Capabilities

Retrieves a value that indicates specific capabilities of a transition.

Progress

Retrieves the setting of the transform's IDXEffect::Progress property. Sets the requested progress made on the transform.

StepResolution

Retrieves the step size that corresponds to the smallest meaningful change for the IDXEffect::Progress property.

Duration

Retrieves the recommended length of time for performing a transition. Sets the suggested duration for the transition.

Capabilities

FUNCTION IDXEffect_get_Capabilities ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pVal AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IDXEffect_get_Capabilities (pthis, pVal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Progress

FUNCTION IDXEffect_get_Progress ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pVal AS SINGLE _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IDXEffect_get_Progress (pthis, pVal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FUNCTION IDXEffect_put_Progress ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pVal AS SINGLE _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IDXEffect_put_Progress (pthis, pVal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

StepResolution

FUNCTION IDXEffect_get_StepResolution ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pVal AS SINGLE _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IDXEffect_get_StepResolution (pthis, pVal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Duration

FUNCTION IDXEffect_get_Duration ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pVal AS SINGLE _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IDXEffect_get_Duration (pthis, pVal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FUNCTION IDXEffect_put_Duration ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pVal AS SINGLE _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[12] USING IDXEffect_put_Duration (pthis, pVal) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION