Skip to content
After Effects C++ SDK ガイド（日本語）

Artisanデータ型

以下は、Artisan API で最も一般的に使用されるデータ型です。

Artisan API で使用されるデータ型

Section titled “Artisan API で使用されるデータ型”
型説明
AEGP_RenderLayerContextHレンダー要求時点のレイヤー状態情報です。After Effects から Artisan へ渡されます。
PR_RenderContextH何をどの条件でレンダリングするかを定義する設定集合です。
AEGP_SoundDataH対象レイヤーのオーディオ設定です。
AEGP_RenderReceiptH
AEGP_FrameReceiptH		Artisan レンダリング時の受領情報（キャッシュ判定など）です。
AEGP_WorldH1 フレーム分のピクセルバッファです。
AEGP_RenderOptionsHレンダーキュー項目に紐づくレンダー設定です。

行列の向き（Horz / Vert）

Section titled “行列の向き（Horz / Vert）”

After Effects の行列は行優先（row-based）、OpenGL は列優先（column-based）です。
座標変換を扱う際は、この差分を吸収する実装が必要です。

実装設計の前提

Section titled “実装設計の前提”

Artisan は「AEGP の 1 機能」というより、小さなレンダラー実装そのものに近い存在です。
交差判定やシェーディングなど、3D レンダリング問題には複数の設計アプローチがあります。

この API は、Adobe 本体とサードパーティの双方が任意の 3D レンダリング方式を実装できるよう設計されています。

3D 合成であり、3D モデリングではない

Section titled “3D 合成であり、3D モデリングではない”

After Effects は 3D モデラー ではありません。
ユーザーは通常、操作中は軽い品質で作業し、確認時や最終出力時のみ高品質に切り替えます。

Artisan 実装では少なくとも 2 つの品質モード（レイアウト用 / 最終出力用）を用意し、低品質時の応答性を重視してください。

Artisan の登録

Section titled “Artisan の登録”

Artisan は AEGP の一種で、単一のエントリポイントを持ちます。
加えて、Artisan 固有の各関数エントリポイントを登録する必要があります。
詳細は AEGP_RegisterSuite5 の AEGP_RegisterArtisan() を参照してください。

次の表は PR_ArtisanEntryPoints で定義される Artisan の実装関数です。必須なのは render_func のみです。

Artisan エントリポイント

Section titled “Artisan エントリポイント”
PR_ArtisanEntryPoints
global_setup_func0Called only once, right after GP_Main. The global data is common across all instances of the plug-in.

If you allocate memory during Global Setup, you must free it during your global_setdown_func.

PR_GlobalSetupFunc(
  const PR_InData    *in_dataP,
  PR_GlobalContextH  global_contextH,
  PR_GlobalDataH     *global_dataPH);
global_setdown_func0Dispose of any global data you allocated.

PR_GlobalSetdownFunc(
  const PR_InData    *in_dataP,
  PR_GlobalContextH  global_contextH,
  PR_GlobalDataH     global_dataH);
global_do_about_func0Tell the world about yourself! Use in_dataP>msg_func to display your dialog.

PR_GlobalDoAboutFunc(
  const PR_InData    *in_dataP,
  PR_GlobalContextH  global_contextH,
  PR_GlobalDataH     global_dataH);
setup_instance_func0Allocate and instantiate any data specific to this instance of your Artisan.

PR_InstanceSetupFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceFlags     flags,
  PR_FlatHandle        flat_dataH0,
  PR_InstanceDataH     *instance_dataPH);
setdown_instance_func0Deallocate and free any data specific to this instance of your Artisan.

PR_InstanceSetdownFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH);
flatten_instance_func0Flatten your data in preparation to being written to disk. (making sure it’s OS independent, if your Artisan is).

PR_FlattenInstanceFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH,
  PR_FlatHandle        *flatH);
do_instance_dialog_func0If your Artisan has a additional parameters (accessed through its Options dialog), this function will be called to get and set them.

PR_DoInstanceDialogFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH,
  PR_DialogResult      *resultP);


PR_DialogResultis is either PR_DialogResult_NO_CHANGE or PR_DialogResult_CHANGE_MADE.
frame_setup_func0Perform any setup necessary to render a frame (called immediately before rendering).

PR_FrameSetupFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH
  PR_RenderContextH    render_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH,
  PR_RenderDataH       *render_dataPH);
frame_setdown_func0Dispose of any setup data allocated during frame_setup (sent immediately after rendering).

PR_FrameSetdownFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH
  PR_RenderContextH    render_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH,
  PR_RenderDataH       render_dataH);
render_funcRender the scene.

PR_FrameRenderFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH
  PR_RenderContextH    render_contextH,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH,
  PR_RenderDataH       render_dataH);
query_func0Artisans can draw their own projection axes, should the need arise.

After Effects will call this function to obtain the transform between the composition world and those axes, as well as for a number of other functions related to on- and off-screen preview drawing (the former is relevant only to interactive artisans).

PR_QueryFunc(
  const PR_InData      *in_dataP,
  PR_GlobalContextH    global_contextH,
  PR_InstanceContextH  instance_contextH
  PR_QueryContextH     query_contextH,
  PR_QueryType         query_type,
  PR_GlobalDataH       global_dataH,
  PR_InstanceDataH     instance_dataH);


PR_QueryType can be one of the following:

- PR_QueryType_NONE = 0
- PR_QueryType_TRANSFORM
- PR_QueryType_INTERACTIVE_WINDOW_DISPOSE
- PR_QueryType_INTERACTIVE_WINDOW_CLEAR
- PR_QueryType_INTERACTIVE_WINDOW_FROZEN_PROXY
- PR_QueryType_INTERACTIVE_SWAP_BUFFER
- PR_QueryType_INTERACTIVE_DRAW_PROCS
- PR_QueryType_PREPARE_FOR_LINE_DRAWING
- PR_QueryType_UNPREPARE_FOR_LINE_DRAWING
- PR_QueryType_GET_CURRENT_CONTEXT_SAFE_FOR_LINE_DRAWING
- PR_QueryType_GET_ARTISAN_QUALITY (New in CS6.)

レンダー対象レイヤーの取得と描画

Section titled “レンダー対象レイヤーの取得と描画”

AEGP_RenderTexture() supplies the raw pixels of a layer, untransformed, into an arbitrarily-sized buffer.

AEGP_RenderLayer() invokes the entire After Effects render pipeline, including transforms, masking, et cetera, providing the layer as it appears in its composition, in a composition-sized buffer.

If the layer being rendered is 3D, the default (Standard 3D) Artisan is invoked to perform any 3D geometrics.

Your Artisan can use this to render track matte layers, and apply them only in a strictly 2D sense, to the transformed 3D layer.

Before rendering, the Artisans that ship with After Effects apply an inverse transform to get square pixels, then re-apply the transform before display.

For example, if the pixel aspect ratio is 10/11 (DV NTSC), we multiply by 11/10 to get square pixels. We process and composite 3D layers, then re-divide to get back to the original pixel aspect ratio.

The following suite supplies the layers, compositions, texture and destination buffers. This is a vital suite for all artisans.

AEGP_CanvasSuite8

Section titled “AEGP_CanvasSuite8”
FunctionPurpose
AEGP_GetCompToRenderGiven the render context provided to the Artisan at render time, returns a handle to the composition.

AEGP_GetCompToRender(
  PR_RenderContextH  render_contextH,
  AEGP_CompH         *compPH)
AEGP_GetNumLayersToRenderGiven the render context, returns the number of layers the Artisan needs to render.

AEGP_GetNumLayersToRender(
  PR_RenderContextH  render_contextH,
  A_long             *num_to_renderPL)
AEGP_GetNthLayerContextToRenderUsed to build a list of layers to render after determining the total number of layers that need rendering by the Artisan.

AEGP_GetNthLayerContextToRender(
  PR_RenderContextH         render_contextH,
  A_long                    n,
  AEGP_RenderLayerContextH  *layer_indexPH)
AEGP_GetLayerFromLayerContextGiven a AEGP_RenderLayerContextH,retrieves the associated AEGP_LayerH (required by many suite functions).

AEGP_GetLayerFromLayerContext(
  const PR_RenderContextH   render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  AEGP_LayerH               *layerPH);
AEGP_GetLayerAndSubLayerFromLayerContextAllows for rendering of sub-layers (as within a Photoshop file).

AEGP_GetLayerAndSubLayerFromLayerContext(
  const PR_RenderContextH   render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  AEGP_LayerH               *layerPH,
  AEGP_SubLayerIndex        *sublayerP);
AEGP_GetTopLayerFromLayerContextWith collapsed geometrics “on” this gives the layer in the root composition containing the layer context.

With collapsed geometrics off this is the same as AEGP_GetLayerFromLayerContext.

AEGP_GetTopLayerFromLayerContext(
  const PR_RenderContextH   r_contextH,
  AEGP_RenderLayerContextH  l_contextH,
  AEGP_LayerH               *layerPH);
AEGP_GetCompRenderTimeGiven the render context, returns the current point in (composition) time to render.

AEGP_GetNthLayerIndexToRender(
  PR_RenderContextH  render_contextH,
  A_long             *time,
  A_long             *time_step)
AEGP_GetCompDestinationBufferGiven the render context, returns a buffer in which to place the final rendered output.

AEGP_GetCompToRender(
  PR_RenderContextH  render_contextH,
  AEGP_CompH         compH,
  PF_EffectWorld     *dst);
AEGP_GetROIGiven the render context provided to the Artisan at render time, returns a handle to the composition.

AEGP_GetROI(
  PR_RenderContextH  render_contextH,
  A_LegacyRect       *roiPR);
AEGP_RenderTextureGiven the render context and layer, returns the layer texture.

All parameters with a trailing ‘0’ are optional; the returned PF_EffectWorld can be NULL.

AEGP_RenderTexture(
  PR_RenderContextH  render_contextH,
  AEGP_LayerH        layerH,
  AEGP_RenderHints   render_hints,
  A_FloatPoint       *suggested_scaleP0,
  A_FloatRect        *suggsted_src_rectP0,
  A_Matrix3          *src_matrixP0,
  PF_EffectWorld     *render_bufferP);


AEGP_RenderHints contains one or more of the following:

- AEGP_RenderHints_NONE
- AEGP_RenderHints_IGNORE_EXTENTS
- AEGP_RenderHints_NO_TRANSFER_MODE (prevents application of opacity & transfer mode; for use with RenderLayer calls.)
AEGP_DisposeTextureDisposes of an acquired layer texture.

AEGP_DisposeTexture(
  PR_RenderContextH  render_contextH,
  AEGP_LayerH        layerH,
  AEGP_WorldH        *dst0);
AEGP_GetFieldRenderReturns the field settings of the given PR_RenderContextH.

AEGP_GetFieldRender(
  PR_RenderContextH  render_contextH,
  PF_Field           *field);
AEGP_ReportArtisanProgressGiven the render context provided to the Artisan at render time, returns a handle to the composition.

!!! note
This is NOT thread-safe on macOS; only use this function when the current thread ID is 0.

AEGP_ReportArtisanProgress(
  PR_RenderContextH  render_contextH,
  A_long             countL,
  A_long             totalL);
AEGP_GetRenderDownsampleFactorReturns the downsample factor of the PR_RenderContextH.

AEGP_GetRenderDownsampleFactor(
  PR_RenderContextH      render_contextH,
  AEGP_DownsampleFactor  *dsfP);
AEGP_IsBlankCanvasDetermines whether the PR_RenderContextH is blank (empty).

AEGP_IsBlankCanvas(
  PR_RenderContextH  render_contextH,
  A_Boolean          *is_blankPB);
AEGP_GetRenderLayerToWorldXformGiven a render context and a layer (at a given time), retrieves the 4 by 4 transform to move between their coordinate spaces.

AEGP_GetRenderLayerToWorldXform(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  const A_Time              *comp_timeP,
  A_Matrix4                 *transform);
AEGP_GetRenderLayerBoundsRetrieves the bounding rectangle of the layer_contextH (at a given time) within the render_contextH.

AEGP_GetRenderLayerBounds(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  const A_Time              *comp_timeP,
  A_LegacyRect              *boundsP);
AEGP_GetRenderOpacityReturns the opacity of the given layer context at the given time, within the render context.

AEGP_GetRenderOpacity(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  const A_Time              *comp_timePT,
  A_FpLong                  *opacityPF);
AEGP_IsRenderLayerActiveReturns whether or not a given layer context is active within the render context, at the given time.

AEGP_IsRenderLayerActive(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  const A_Time              *comp_timePT,
  A_Boolean                 *activePB);
AEGP_SetArtisanLayerProgressSets the progress information for a rendering Artisan.

- countL is the number of layers completed,
- num_layersL is the total number of layers the Artisan is rendering.

AEGP_SetArtisanLayerProgress(
  PR_RenderContextH  render_contextH,
  A_long             countL,
  A_long             num_layersL);
AEGP_RenderLayerPlusSimilar to AEGP_RenderLayer, but takes into account the AEGP_RenderLayerContextH.

AEGP_RenderLayerPlus(
  PR_RenderContextH          r_contextH,
  AEGP_LayerH                layerH,
  AEGP_RenderLayerContextH   l_contextH,
  AEGP_RenderHints           render_hints,
  AEGP_WorldH                *bufferP);
AEGP_GetTrackMatteContextRetrieves the AEGP_RenderLayerContextH for the specified render and fill contexts.

AEGP_GetTrackMatteContext(
  PR_RenderContextH         rnder_contextH,
  AEGP_RenderLayerContextH  fill_contextH,
  AEGP_RenderLayerContextH  *mattePH);
AEGP_RenderTextureWithReceiptRenders a texture into an AEGP_WorldH, and provides an AEGP_RenderReceiptH for the operation.

The returned receiptPH must be disposed of with AEGP_DisposeRenderReceipt.

AEGP_RenderTextureWithReceipt(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  AEGP_RenderHints          render_hints,
  A_FloatPoint              *suggested_scaleP0,
  A_FloatRect               *suggest_src_rectP0,
  A_Matrix3                 *src_matrixP0,
  AEGP_RenderReceiptH       *receiptPH,
  AEGP_WorldH               *dstPH);
AEGP_GetNumberOfSoftwareEffectsReturns the number of software effects applied in the given AEGP_RenderLayerContextH.

AEGP_GetNumberOfSoftwareEffects(
  PR_RenderContextH         ren_contextH,
  AEGP_RenderLayerContextH  lyr_contextH,
  A_short                   *num_sft_FXPS);
AEGP_RenderLayerPlusWithReceiptAn improvement over AEGP_RenderLayerPlus, this function also provides an AEGP_RenderReceiptH for caching purposes.

AEGP_RenderLayerPlusWithReceipt(
  PR_RenderContextH            render_contextH,
  AEGP_LayerH                  layerH,
  AEGP_RenderLayerContextH     layer_contextH,
  AEGP_RenderHints             render_hints,
  AEGP_NumEffectsToRenderType  num_effectsS,
  AEGP_RenderReceiptH          *receiptPH,
  AEGP_WorldH                  *bufferPH);
AEGP_DisposeRenderReceiptFrees an AEGP_RenderReceiptH.

AEGP_DisposeRenderReceipt(
  AEGP_RenderReceiptH  receiptH);
AEGP_CheckRenderReceiptChecks with After Effects’ internal caching to determine whether a given AEGP_RenderReceiptH is still valid.

AEGP_CheckRenderReceipt(
  PR_RenderContextH            current_contextH,
  AEGP_RenderLayerContextH     current_lyr_ctxtH,
  AEGP_RenderReceiptH          old_receiptH,
  A_Boolean                    check_aceB,
  AEGP_NumEffectsToRenderType  num_effectsS,
  AEGP_RenderReceiptStatus     *receipt_statusP);
AEGP_GenerateRenderReceiptGenerates a AEGP_RenderReceiptH for a layer as if the first num_effectsS have been rendered.

AEGP_GenerateRenderReceipt(
  PR_RenderContextH            current_contextH,
  AEGP_RenderLayerContextH     current_lyr_contextH,
  AEGP_NumEffectsToRenderType  num_effectsS,
  AEGP_RenderReceiptH          *render_receiptPH);
AEGP_GetNumBinsToRenderReturns the number of bins After Effects wants the artisan to render.

AEGP_GetNumBinsToRender(
  const PR_RenderContextH  contextH,
  A_long                   *num_binsPL);
AEGP_SetNthBinSets the given render context to be the n-th bin to be rendered by After Effects.

AEGP_SetNthBin(
  const PR_RenderContextH  contextH,
  A_long                   n);
AEGP_GetBinTypeRetrieves the type of the given bin.

AEGP_GetBinType(
  const PR_RenderContextH  contextH,
  AEGP_BinType             *bin_typeP);


AEGP_BinType will be one of the following:

- AEGP_BinType_NONE
- AEGP_BinType_2D
- AEGP_BinType_3D
AEGP_GetRenderLayerToWorldXform2D3DRetrieves the transform to correctly orient the layer being rendered with the output world.

Pass TRUE for only_2dB to constrain the transform to two dimensions.

AEGP_GetRenderLayerToWorldXform2D3D(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  const A_Time              *comp_timeP,
  A_Boolean                 only_2dB,
  A_Matrix4                 *transformP);
FunctionPurpose
AEGP_GetPlatformWindowRefRetrieves the platform-specific window context into which to draw the given PR_RenderContextH.

AEGP_GetPlatformWindowRef(
  const PR_RenderContextH  contextH,
  AEGP_PlatformWindowRef   *window_refP);
AEGP_GetViewportScaleRetrieves the source-to-frame downsample factor for the given PR_RenderContextH.

AEGP_GetViewportScale(
  const PR_RenderContextH  contextH,
  A_FpLong                 *scale_xPF,
  A_FpLong                 *scale_yPF);
AEGP_GetViewportOriginRetrieves to origin of the source, within the frame (necessary to translate between the two), for the given PR_RenderContextH.

AEGP_GetViewportOrigin(
  const PR_RenderContextH  contextH,
  A_long                   *origin_xPL,
  A_long                   *origin_yPL);
AEGP_GetViewportRectRetrieves the bounding rectangle for the area to be drawn, for the given PR_RenderContextH.

AEGP_GetViewportRect(
  const PR_RenderContextH  contextH,
  A_LegacyRect             *v_rectPR);
AEGP_GetFallowColorRetrieves the color used for the fallow regions in the given PR_RenderContextH.

AEGP_GetFallowColor(
  const PR_RenderContextH  contextH,
  PF_Pixel8                *fallow_colorP);
AEGP_GetInteractiveCheckerboardRetrieves whether or not the checkerboard is currently active for the given PR_RenderContextH.

AEGP_GetInteractiveCheckerboard(
  const PR_RenderContextH  contextH,
  A_Boolean                *cboard_onPB);
AEGP_GetInteractiveCheckerboardColorsRetrieves the colors used in the checkerboard.

AEGP_GetInteractiveCheckerboardColors(
  const PR_RenderContextH  contextH,
  PF_Pixel                 *color1P,
  PF_Pixel                 *color2P);
AEGP_GetInteractiveCheckerboardSizeRetrieves the width and height of one checkerboard square.

AEGP_GetInteractiveCheckerboardSize(
  const PR_RenderContextH  contextH,
  A_u_long                 *cbd_widthPLu,
  A_u_long                 *cbd_heightPLu);
AEGP_GetInteractiveCachedBufferRetrieves the cached AEGP_WorldH last used for the PR_RenderContextH.

AEGP_GetInteractiveCachedBuffer(
  const PR_RenderContextH  contextH,
  AEGP_WorldH              *buffer);
AEGP_ArtisanMustRenderAsLayerDetermines whether or not the artisan must render the current AEGP_RenderLayerContextH as a layer.

AEGP_ArtisanMustRenderAsLayer(
  const PR_RenderContextH   contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  A_Boolean                 *use_txturePB);
AEGP_GetInteractiveDisplayChannelReturns which channels should be displayed by the interactive artisan.

AEGP_GetInteractiveDisplayChannel(
  const PR_RenderContextH  contextH,
  AEGP_DisplayChannelType  *channelP);


AEGP_DisplayChannelType will be one of the following:

- AEGP_DisplayChannel_NONE
- AEGP_DisplayChannel_RED
- AEGP_DisplayChannel_GREEN
- AEGP_DisplayChannel_BLUE
- AEGP_DisplayChannel_ALPHA
- AEGP_DisplayChannel_RED_ALT
- AEGP_DisplayChannel_GREEN_ALT
- AEGP_DisplayChannel_BLUE_ALT
- AEGP_DisplayChannel_ALPHA_ALT
AEGP_GetInteractiveExposureReturns the exposure for the given PR_RenderContextH, expressed as a floating point number.

AEGP_GetInteractiveExposure(
  const PR_RenderContextH  rcH,
  A_FpLong                 *exposurePF);
AEGP_GetColorTransformReturns the color transform for the given PR_RenderContextH.

AEGP_GetColorTransform(
  const PR_RenderContextH  render_contextH,
  A_Boolean                *cms_onB,
  A_u_long                 *xform_keyLu,
  void                      *xformP);
AEGP_GetCompShutterTimeReturns the shutter angle for the given PR_RenderContextH.

AEGP_GetCompShutterTime(
  PR_RenderContextH  render_contextH,
  A_Time             *shutter_time,
  A_Time             *shutter_dur);
AEGP_MapCompToLayerTimeNew in CC. Unlike AEGP_ConvertCompToLayerTime, this handles time remapping with collapsed or nested comps.

AEGP_MapCompToLayerTime(
  PR_RenderContextH         render_contextH,
  AEGP_RenderLayerContextH  layer_contextH,
  const A_Time              *comp_timePT,
  A_Time                    *layer_timePT);

コンテキスト間の変換

Section titled “コンテキスト間の変換”

Convert between render and instance contexts, and manage global data specific to the artisan.

AEGP_ArtisanUtilSuite1

Section titled “AEGP_ArtisanUtilSuite1”
FunctionPurpose
AEGP_GetGlobalContextFromInstanceContextGiven an instance context, returns a handle to the global context.

AEGP_GetGlobalContextFromInstanceContext(
  const PR_InstanceContextH  instance_contextH,
  PR_GlobalContextH          *global_contextPH);
AEGP_GetInstanceContextFromRenderContextGiven the render context, returns a handle to the instance context.

AEGP_GetInstanceContextFromRenderContext(
  const PR_RenderContextH  render_contextH,
  PR_InstanceContextH      *instnc_ctextPH);
AEGP_GetInstanceContextFromQueryContextGiven a query context, returns a handle to the instance context.

AEGP_GetInstanceContextFromQueryContext(
  const PR_QueryContextH  query_contextH,
  PR_InstanceContextH     *instnce_contextPH);
AEGP_GetGlobalDataGiven the global context, returns a handle to global data.

AEGP_GetGlobalData(
  const PR_GlobalContextH  global_contextH,
  PR_GlobalDataH           *global_dataPH);
AEGP_GetInstanceDataGiven an instance context, return the associated instance data.

AEGP_GetInstanceData(
  const PR_InstanceContextH  instance_contextH,
  PR_InstanceDataH           *instance_dataPH);
AEGP_GetRenderDataGiven a render context, returns the associated render data.

AEGP_GetRenderData(
  const PR_RenderContextH  render_contextH,
  PR_RenderDataH           *render_dataPH);

カメラ情報

Section titled “カメラ情報”

Obtains the camera geometry, including camera properties (type, lens, depth of field, focal distance, aperture, et cetera).

AEGP_CameraSuite2

Section titled “AEGP_CameraSuite2”
FunctionPurpose
AEGP_GetCameraGiven a layer handle and time, returns the current camera layer handle.

AEGP_GetCamera(
  PR_RenderContextH  render_contextH,
  const A_Time       *comp_timeP,
  AEGP_LayerH        *camera_layerPH);
AEGP_GetCameraTypeGiven a layer, returns the camera type of the layer.

AEGP_GetCameraType(
  AEGP_LayerH      aegp_layerH,
  AEGP_CameraType  *camera_typeP;


The camera type can be the following:

- AEGP_CameraType_NONE = -1
- AEGP_CameraType_PERSPECTIVE
- AEGP_CameraType_ORTHOGRAPHIC
AEGP_GetDefaultCameraDistanceToImagePlaneGiven a composition handle, returns the camera distance to the image plane.

AEGP_GetDefaultCamera DistanceToImagePlane(
  AEGP_CompH  compH,
  A_FpLong    *dist_to_planePF)
AEGP_GetCameraFilmSizeRetrieves the size (and units used to measure that size) of the film used by the designated camera.

AEGP_GetCameraFilmSize(
  AEGP_LayerH         camera_layerH,
  AEGP_FilmSizeUnits  *film_size_unitsP,
  A_FpLong            *film_sizePF0);
AEGP_SetCameraFilmSizeSets the size (and unites used to measure that size) of the film used by the designated camera.

AEGP_SetCameraFilmSize)(
  AEGP_LayerH         camera_layerH,
  AEGP_FilmSizeUnits  film_size_units,
  A_FpLong            *film_sizePF0);

カメラの動作に関する注意事項

Section titled “カメラの動作に関する注意事項”

カメラの向きは合成座標で表され、回転はレイヤー (カメラのレイヤー) 座標で表されます。

カメラ レイヤに親がある場合、位置は親を基準とした座標空間内にあります。

正投影カメラ マトリックス

Section titled “正投影カメラ マトリックス”

内部的には、コンポジションの幅と高さを使用して、OpenGL 仕様で記述されているマトリックスを次のように設定します。

glOrtho(-width/2, width/2, -height/2, height/2, -1, 100);

正投影行列は投影を表します。カメラの位置は、別のスケーリングされた行列によって記述されます。カメラ位置行列の逆行列により、「目」の座標が得られます。

フォーカルに焦点を当てる

Section titled “フォーカルに焦点を当てる”

焦点距離は視野に影響することに注意してください。焦点距離は被写界深度にのみ影響します。

フィルムサイズ

Section titled “フィルムサイズ”

現実の世界では、フィルムのサイズはミリメートル単位で測定されます。 After Effects では、ピクセル単位で測定されます。ミリメートルからピクセルに移動するには、72 を掛けて 25.4 で割ります。

視野はより複雑です。

ϴ = 1/2 視野

Tan(ϴ) = 1/2 構図の高さ / 焦点距離

焦点距離 = 2tan(ϴ) / 構図の高さ

ライトを当てよう!

Section titled “ライトを当てよう!”

コンポジション内のライトのタイプを取得および設定します。

AEGP_LightSuite2

Section titled “AEGP_LightSuite2”
FunctionPurpose
AEGP_GetLightTypeRetrieves the AEGP_LightType of the specified camera layer.

AEGP_GetLightType(
  AEGP_LayerH     light_layerH,
  AEGP_LightType  *light_typeP);


AEGP_LightType will be one of the following:

- AEGP_LightType_PARALLEL
- AEGP_LightType_SPOT
- AEGP_LightType_POINT
- AEGP_LightType_AMBIENT
AEGP_SetLightTypeSets the AEGP_LightType for the specified camera layer.

AEGP_SetLightType(
  AEGP_LayerH     light_layerH,
  AEGP_LightType  light_type);

ライト挙動の注意点

Section titled “ライト挙動の注意点”

The formula for parallel lights is found in Foley and Van Dam’s “Introduction to Computer Graphics” (ISBN 0-201-60921-5) as is the formula for point lights.

We use the half angle variant proposed by Jim Blinn instead.

Suppose we have a point on a layer and want to shade it with the light.

Let V be the unit vector from the layer point to the eye point. Let L be the unit vector to the light (in the parallel light case this is constant). Let H be (V+L)/2 (normalized). Let N be the unit normal vector to the layer.

The amount of specular reflected light is S * power(H Dot N, shine), where S is the specular coefficient.

3D ハンドル描画

Section titled “3D ハンドル描画”

After Effects relies upon Artisans to draw 3D layer handles. If your Artisan chooses not to respond to this call, the default Artisan will draw 3D layer handles for you. Querying transforms is important for optimization of After Effects’ caching.

The coordinate system is positive x to right, positive y down, positive z into the screen. The origin is the upper left corner. Rotations are x then y then z. For matrices the translate is the bottom row, orientations are quaternions (which are applied first), then any x-y-z rotation after that. As a general rule, use orientation or rotation but not both. Also use rotations if you need control over angular velocity.

変換クエリ関数

Section titled “変換クエリ関数”

These functions give artisans information about the transforms they’ll need in order to correctly place layers within a composition and respond appropriately to the various queries After Effects will send to their PR_QueryFunc entry point function.

As that entry point is optional, so is your artisan’s response to the queries; however, if you don’t, your users may be disappointed that (while doing interactive preview drawing) all the camera and light indicators vanish, until they stop moving! Artisans are complex beasts; contact us if you have any questions.

AEGP_QueryXFormSuite2

Section titled “AEGP_QueryXFormSuite2”
FunctionPurpose
AEGP_QueryXformGetSrcTypeGiven a query context, returns trasnsform source currently being modified.

AEGP_QueryXformGetSrcType(
  PR_QueryContextH     query_contextH,
  AEGP_QueryXformType  *src_type);


The query context will be one of the following:

- AEGP_Query_Xform_LAYER
- AEGP_Query_Xform_WORLD
- AEGP_Query_Xform_VIEW
- AEGP_Query_Xform_SCREEN
AEGP_QueryXformGetDstTypeGiven a query context, returns the currently requested transform destination.

AEGP_QueryXformGetDstType(
  PR_QueryContextH     query_contextH,
  AEGP_QueryXformType  *dst_type);
AEGP_QueryXformGetLayerUsed if the source or destination type is a layer. Given a query context, returns the layer handle.

AEGP_QueryXformGetLayer(
  PR_QueryContextH  query_contextH,
  AEGP_LayerH       *layerPH);
AEGP_QueryXformGetCompGiven a query context, returns the current composition handle.

AEGP_QueryXformGetComp(
  PR_QueryContextH  query_contextH,
  AEGP_CompH        *compPH);
AEGP_QueryXformGetTransformTimeGiven a query context, returns the time of the transformation.

AEGP_QueryXformGetTransformTime(
  PR_QueryContextH  query_contextH,
  A_Time            *time);
AEGP_QueryXformGetViewTimeGiven a query context, returns the time of the associated view.

AEGP_QueryXformGetViewTime(
  PR_QueryContextH  query_contextH,
  A_Time            *time);
AEGP_QueryXformGetCameraGiven a query context, returns the current camera layer handle.

AEGP_QueryXformGetCamera(
  PR_QueryContextH  query_contextH,
  AEGP_LayerH       *camera_layerPH);
AEGP_QueryXformGetXformGiven a query context, returns the current matrix transform.

AEGP_QueryXformGetXform(
  PR_QueryContextH  query_contextH,
  A_Matrix4         *xform);
AEGP_QueryXformSetXformGiven a query context, return the matrix transform you compute in xform.

AEGP_QueryXformSetXform(
  PR_QueryContextH  query_contextH,
  A_Matrix4         *xform);
AEGP_QueryWindowRefSets the window reference to be used (by After Effects) for the given PR_QueryContextH.

AEGP_QueryWindowRef(
  PR_QueryContextH        q_contextH,
  AEGP_PlatformWindowRef  *window_refP);
AEGP_QueryWindowClearReturns which AEGP_PlatformWindowRef (and A_Rect) to clear, for the given PR_QueryContextH.

AEGP_QueryWindowClear(
  PR_QueryContextH        q_contextH,
  AEGP_PlatformWindowRef  *window_refP,
  A_LegacyRect            *boundsPR);
AEGP_QueryFrozenProxyReturns whether or not the textures used in the given PR_QueryContextH should be frozen.

AEGP_QueryFrozenProxy(
  PR_QueryContextH  q_contextH,
  A_Boolean         *onPB);
AEGP_QuerySwapBufferSent after rendering and camera/light handle drawing is complete; After Effects returns the buffer into which the artisan should draw its output.

AEGP_QuerySwapBuffer(
  PR_QueryContextH        q_contextH,
  AEGP_PlatformWindowRef  *window_refP,
  AEGP_WorldH             *dest_bufferp);
AEGP_QueryDrawProcsSets the interactive drawing functions After Effects will call while drawing camera and lighting handles into the artisan’s provided context.

AEGP_QueryDrawProcs(
  PR_QueryContextH         query_contextH,
  PR_InteractiveDrawProcs  *window_refP);
AEGP_QueryPrepareForLineDrawingInforms After Effects about the context into which it will be drawing.

AEGP_QueryPrepareForLineDrawing(
  PR_QueryContextH        query_contextH,
  AEGP_PlatformWindowRef  *window_refP,
  A_LegacyRect            *viewportP,
  A_LPoint                *originP,
  A_FloatPoint            *scaleP);
AEGP_QueryUnprepareForLineDrawingAs far as After Effects is concerned, the artisan is done drawing lines.

AEGP_QueryUnprepareForLineDrawing(
  PR_QueryContextH        query_contextH,
  AEGP_PlatformWindowRef  *window_refP);

インタラクティブ描画関数

Section titled “インタラクティブ描画関数”

We’ve added the ability for artisans to provide functions After Effects can use to do basic drawing functions for updating the comp window display during preview, including camera, light, and wireframe preview modeling.

PR_InteractiveDrawProcs

Section titled “PR_InteractiveDrawProcs”
FunctionPurpose
PR_Draw_MoveToFunc
PR_Draw_MoveToFunc(
  short  x,
  short  y);
PR_Draw_LineToFunc
PR_Draw_LineToFunc(
  short  x,
  short  y);
PR_Draw_ForeColorFunc
PR_Draw_ForeColorFunc(
  const A_Color  *fore_colo
PR_Draw_FrameRectFunc
PR_Draw_FrameRectFunc(
  const A_Rect  *rectPR );
PR_Draw_PaintRectFunc
PR_Draw_PaintRectFunc(
  const A_Rect  *rectPR );

クエリ時関数に関する注意事項

Section titled “クエリ時関数に関する注意事項”

AEGP_QueryXformGetTransformTime() と AEGP_QueryXformGetViewTime() は両方とも、職人がレンダリングするシーンの表現を構築するために必要です。

AEGP_QueryXformGetTransformTime() は変換の時間を取得し、AEGP_CompSuite11 から AEGP_GetCompShutterFrameRange() に渡します。

AEGP_QueryXformGetViewTime() はビューの時間を取得します。これは AEGP_LayerSuite9 から AEGP_GetLayerToWorldXformFromView() を呼び出す際に使用されます。