共通プロパティ
ライブラリに登録されている各オブジェクトは、共通の基底クラスからプロパティを継承しています。各オブジェクトの個別ページでは、そのクラスで新たに宣言されたプロパティのみを掲載しているため、継承される共通プロパティは本ページを参照してください。
以下の型はプロパティの値の型です。拡張機能のコードでは drawable.Opacity.Value のようにプロパティオブジェクトの .Value を読み書きし、描画コードでは評価済みの Resource を参照します。EngineObject とプロパティも参照してください。
以下は基底クラスの継承関係です:
EngineObject
├─ Drawable
│ ├─ Shape (Pen, Fill)
│ └─ AudioVisualizerDrawable
├─ FilterEffect
├─ Transform
├─ Sound
├─ AudioEffect
├─ Object3D
│ └─ Group3D
└─ Light3D
EngineObject
宣言ファイル: src/Beutl.Engine/Engine/EngineObject.cs、継承元: Hierarchical。
IsTimeAnchor、IsEnabled、ZIndex、TimeRange は値だけを持つプロパティオブジェクトです。型はそれぞれ IProperty<bool>、IProperty<bool>、IProperty<int>、IProperty<TimeRange> で、通常のプロパティ一覧には表示されません。Start と Duration は TimeRange.Value から取得する読み取り専用の MediaTime です。
描画オブジェクト (Drawable)
宣言ファイル: src/Beutl.Engine/Graphics/Drawable.cs、継承元: EngineObject。
トランスフォーム (Transform)
描画オブジェクトに適用する 2D トランスフォーム(移動 / 拡大縮小 / 回転 / 歪み)。コンストラクタで空の TransformGroup がインスタンス化されるため、追加のトランスフォームを差し込めます。エディターで追加したオブジェクトでは、このグループに最初から移動、回転、スケールが入ります。トランスフォームとエフェクトを参照してください。
- 型:
Transform? - 既定値: 空の
TransformGroup - アニメーション: 不可
アライメントX (AlignmentX)
描画オブジェクトの境界内における水平方向の配置。
- 型:
AlignmentX - 既定値: 中心 (
AlignmentX.Center) - アニメーション: 可
アライメントY (AlignmentY)
描画オブジェクトの境界内における垂直方向の配置。
- 型:
AlignmentY - 既定値: 中心 (
AlignmentY.Center) - アニメーション: 可
トランスフォームの起点 (TransformOrigin)
Transform の基準点(相対座標、または絶対座標)。
- 型:
RelativePoint - 既定値: 中心 (
RelativePoint.Center) - アニメーション: 可
フィルターエフェクト (FilterEffect)
描画後に適用するフィルターエフェクトチェーン(任意)。コンストラクタで空の FilterEffectGroup がインスタンス化されるため、エフェクトを追加で差し込めます。
- 型:
FilterEffect? - 既定値: 空の
FilterEffectGroup - アニメーション: 不可
ブレンドモード (BlendMode)
この描画オブジェクトをキャンバスに合成する際のブレンドモード。
- 型:
BlendMode - 既定値: 前面合成 (
BlendMode.SrcOver) - アニメーション: 可
不透明度 (Opacity)
レイヤーの不透明度(パーセント。0 で透明、100 で完全不透明)。
- 型:
float - 既定値:
100 - アニメーション: 可
- 範囲:
[0, 100]
シェイプ (Shape)
宣言ファイル: src/Beutl.Engine/Graphics/Shapes/Shape.cs、継承元: Drawable。
ストローク (Pen)
輪郭線を描画する Pen。なし (null) のとき輪郭は描画されません。
- 型:
Pen? - 既定値: なし (
null) - アニメーション: 不可
ペンの 重ね順(StrokeOrder)は、ペンのエディターの 位置 のすぐ下にあり、ストロークを塗りの上に描くかどうかを選びます。既定は 塗りの前面(AboveFill)です。塗りの背面(BelowFill)では塗りの下に描くので、太いストロークが図形に食い込まない縁取りになります。アニメーションはできません。
塗りつぶし (Fill)
内部を塗るブラシ。なし (null) のとき塗りなしになります。
- 型:
Brush? - 既定値:
#FFFFFFFF(白) - アニメーション: 不可
グラデーションのブラシでは、分岐点の間の色をどう混ぜるかも選べます。補間の色空間(InterpolationSpace)は、光を混ぜる リニア sRGB(LinearSrgb、既定)では黒と白の中間が 8 bit の sRGB で 188 になり、CSS の既定と同じく保存された値を混ぜる sRGB(Srgb)では 128 になります。OKLab(Oklab)では明るさが見た目に均等に変わり、間の色もくすみません。乗算済みアルファで補間(InterpolatePremultiplied、既定はオフ)はアルファを掛けた色で混ぜるので、透明な分岐点が自身の色を持ち込みません。どちらもアニメーションはできません。ブラシエディターの見本と分岐点のバーは、描画されるとおりのグラデーションを表示します。宣言ファイル: GradientBrush.cs。
サウンド (Sound)
宣言ファイル: src/Beutl.Engine/Audio/Sound.cs、継承元: EngineObject。
オフセット位置 (OffsetPosition)
ソース音声内のどの時刻から再生を開始するか。
- 型:
MediaTime - 既定値:
00:00:00 - アニメーション: 不可
ゲイン (Gain)
音量(パーセント。100 が原音)。マスター出力はすべてのサンプルをフルスケール内に収めるので、大きなゲインでも 0 dBFS を超えません。
- 型:
float - 既定値:
100 - アニメーション: 可
- 範囲:
[0, ∞)
スピード (Speed)
再生速度(パーセント。100 が等倍)。
- 型:
float - 既定値:
100 - アニメーション: 可
- 範囲:
[0, ∞)
音声エフェクト (Effect)
コンストラクタで空の AudioEffectGroup がインスタンス化されるため、エフェクトを追加で差し込めます。
- 型:
AudioEffect? - 既定値: 空の
AudioEffectGroup - アニメーション: 不可
パン (Pan)
左右のバランス。0 では左右とも元のレベルで、-100 では右側、100 では左側が無音になります。このプロパティと続く 3 つのプロパティは パンナー セクションで編集します。マルチチャンネル音声を参照してください。
- 型:
float - 既定値:
0 - アニメーション: 可
- 範囲:
[-100, 100]
前後 (SurroundPan)
5.1ch / 7.1ch のプロジェクトで、モノラルまたはステレオのサウンドをフロントからサラウンドへ、音量感を保ったまま移動します。7.1ch では 50 がサイド、100 がリアのスピーカーです。
- 型:
float - 既定値:
0 - アニメーション: 可
- 範囲:
[0, 100]
センター (CenterLevel)
5.1ch / 7.1ch のプロジェクトで、モノラルまたはステレオのサウンドのフロントの音の一部をセンタースピーカーに送ります。パン が中央から離れるほど少なくなります。
- 型:
float - 既定値:
0 - アニメーション: 可
- 範囲:
[0, 100]
LFE (LfeLevel)
5.1ch / 7.1ch のプロジェクトで、モノラルまたはステレオのサウンドを 120 Hz のローパスに通して LFE チャンネルに送ります。
- 型:
float - 既定値:
0 - アニメーション: 可
- 範囲:
[0, 100]
オーディオビジュアライザー (AudioVisualizerDrawable)
宣言ファイル: src/Beutl.Engine/Graphics/AudioVisualizers/AudioVisualizerDrawable.cs、継承元: Drawable。
ソース (Source)
可視化対象のサウンドソース。
- 型:
Sound? - 既定値: なし (
null) - アニメーション: 不可
幅 (Width)
可視化の幅(ピクセル)。
- 型:
float - 既定値:
640 - アニメーション: 可
- 範囲:
[1, ∞)
高さ (Height)
可視化の高さ(ピクセル)。
- 型:
float - 既定値:
120 - アニメーション: 可
- 範囲:
[1, ∞)
プロパティパネルでは、幅 と 高さ が 1 つの サイズ の行にまとめて表示されます。1 行にまとめて表示される値を参照してください。
塗りつぶし (Fill)
バーや線を描くブラシ。
- 型:
Brush? - 既定値:
#FFFFFFFF(白) - アニメーション: 不可
ゲイン (Gain)
描画前に適用するビジュアライザー専用のゲイン(1 が原寸)。
- 型:
float - 既定値:
1 - アニメーション: 可
- 範囲:
[0.01, 1000]
フィルターエフェクト (FilterEffect)
宣言ファイル: src/Beutl.Engine/Graphics/FilterEffects/FilterEffect.cs、継承元: EngineObject。
IsTimeAnchor、IsEnabled、ZIndex、TimeRange は値だけを持つプロパティオブジェクトです。型はそれぞれ IProperty<bool>、IProperty<bool>、IProperty<int>、IProperty<TimeRange> で、通常のプロパティ一覧には表示されません。Start と Duration は TimeRange.Value から取得する読み取り専用の MediaTime です。
トランスフォーム (Transform)
宣言ファイル: src/Beutl.Engine/Graphics/Transformation/Transform.cs、継承元: EngineObject。
IsTimeAnchor、IsEnabled、ZIndex、TimeRange は値だけを持つプロパティオブジェクトです。型はそれぞれ IProperty<bool>、IProperty<bool>、IProperty<int>、IProperty<TimeRange> で、通常のプロパティ一覧には表示されません。Start と Duration は TimeRange.Value から取得する読み取り専用の MediaTime です。
音声エフェクト (AudioEffect)
宣言ファイル: src/Beutl.Engine/Audio/Effects/AudioEffect.cs、継承元: EngineObject。
IsTimeAnchor、IsEnabled、ZIndex、TimeRange は値だけを持つプロパティオブジェクトです。型はそれぞれ IProperty<bool>、IProperty<bool>、IProperty<int>、IProperty<TimeRange> で、通常のプロパティ一覧には表示されません。Start と Duration は TimeRange.Value から取得する読み取り専用の MediaTime です。
3Dオブジェクト (Object3D)
Beutlの3D座標は、+Xが右、+Yが下、+Zが奥で、1単位は1ピクセルです。モデルの既定スケールは (100, 100, 100) です。2D描画オブジェクトは専用の非ライティングマテリアルを使用し、マテリアルの編集欄は表示せず、影の投影は既定で無効です。
宣言ファイル: src/Beutl.Engine/Graphics3D/Object3D.cs、継承元: EngineObject。
位置 (Position)
3D 空間でのローカル位置。
- 型:
Vector3 - 既定値:
(0, 0, 0) - アニメーション: 可
回転 (Rotation)
ローカル回転(オイラー角・度)。
- 型:
Vector3 - 既定値:
(0, 0, 0) - アニメーション: 可
スケール (Scale)
軸ごとのローカルスケール(倍率。1 が元の大きさ)。
- 型:
Vector3 - 既定値:
(1, 1, 1) - アニメーション: 可
マテリアル (Material)
サーフェスのシェーディングを定義するマテリアル。
- 型:
Material3D? - 既定値:
PBRMaterial(Group3Dではnullで上書きされます) - アニメーション: 不可
アンリットマテリアル(UnlitMaterial.cs)は、ライティングなしで色とカラーマップを表示します。アルファモード(AlphaMode、アニメーション不可)でアルファの扱いを決めます。
- 自動(既定): 色と不透明度からマテリアルが決めます。以前のバージョンと同じ動作です。
- 不透明: アルファを無視し、深度を書き込みます。カラーマップがアルファ 0 の下に保存している色も表示されます。
- マスク: アルファが 切り抜きのしきい値(
AlphaCutoff、既定は0.5、0〜1)より小さいピクセルを捨て、残りを不透明にして、深度を書き込みます。切り抜いた部分は光を通すので影を落とさず、カラーマップが画像のときはポインターも通します。 - ブレンド: 背後のものと混ぜ合わせ、深度は書き込みません。
影を投影する (CastShadows)
true のとき、このオブジェクトはシャドウを落とします。
- 型:
bool - 既定値:
true - アニメーション: 可
影を受ける (ReceiveShadows)
true のとき、このオブジェクトはシャドウを受け取ります。
- 型:
bool - 既定値:
true - アニメーション: 可
3Dグループ (Group3D)
宣言ファイル: src/Beutl.Engine/Graphics3D/Group3D.cs、継承元: Object3D。
IsTimeAnchor、IsEnabled、ZIndex、TimeRange は値だけを持つプロパティオブジェクトです。型はそれぞれ IProperty<bool>、IProperty<bool>、IProperty<int>、IProperty<TimeRange> で、通常のプロパティ一覧には表示されません。Start と Duration は TimeRange.Value から取得する読み取り専用の MediaTime です。
3Dライト (Light3D)
宣言ファイル: src/Beutl.Engine/Graphics3D/Lighting/Light3D.cs、継承元: EngineObject。
色 (Color)
ライトの色。
- 型:
Color - 既定値: 白 (
#FFFFFF) - アニメーション: 可
強度 (Intensity)
ライトの明るさの倍率。
- 型:
float - 既定値:
1 - アニメーション: 可
- 範囲:
[0, ∞)
影を投影 (CastsShadow)
true のとき、このライトはシャドウを生成します。
- 型:
bool - 既定値:
false - アニメーション: 可
シャドウバイアス (ShadowBias)
シャドウ比較に加える定数バイアス(シャドウアクネ対策)。
- 型:
float - 既定値:
0.0001 - アニメーション: 可
- 範囲:
[0, 0.01]
シャドウ法線バイアス (ShadowNormalBias)
シャドウのにじみを抑えるための法線方向バイアス。
- 型:
float - 既定値:
2 - アニメーション: 可
- 範囲:
[0, 10]
影の強度 (ShadowStrength)
通常のライティングとシャドウ領域のミックス比(1 でフルシャドウ)。
- 型:
float - 既定値:
1 - アニメーション: 可
- 範囲:
[0, 1]