Struct EditSection 

pub struct EditSection {
    pub info: EditInfo,
    /* private fields */
}

Available on crate feature generic only.

編集セクションのハンドル。

Fields

info: EditInfo

編集情報。

Implementations

impl EditSection

pub unsafe fn from_raw(ptr: *mut EDIT_SECTION) -> Self

生ポインタから EditSection を作成します。

Safety

有効な EDIT_SECTION ポインタである必要があります。

pub fn create_object_from_alias( &self, alias: &str, layer: usize, frame: usize, length: usize, ) -> EditSectionResult<ObjectHandle>

オブジェクトエイリアスから指定の位置にオブジェクトを作成します。

Arguments

• alias：オブジェクトエイリアスのデータ。オブジェクトエイリアスと同じフォーマットで指定します。
• layer：作成するオブジェクトのレイヤー番号（0始まり）。
• frame：作成するオブジェクトのフレーム番号（0始まり）。
• length：作成するオブジェクトの長さ（フレーム数）。

lengthはエイリアスデータにフレーム情報が無い場合に利用されます。

Errors

エイリアスの変換に失敗した場合、またはオブジェクトが既存のオブジェクトに重なる場合にエラー

pub fn find_object_after( &self, layer: usize, frame: usize, ) -> EditSectionResult<Option<ObjectHandle>>

指定のフレーム番号以降にあるオブジェクトを検索します。

Arguments

• layer：検索するレイヤー番号（0始まり）。
• frame：検索を開始するフレーム番号（0始まり）。

pub fn count_object_effect( &self, object: &ObjectHandle, effect: &str, ) -> EditSectionResult<usize>

オブジェクトに対象エフェクトが何個存在するかを取得します。

Arguments

• object：対象のオブジェクトハンドル。
• effect：対象のエフェクト名。（エイリアスファイルの effect.name の値）

Returns

対象エフェクトの数。存在しない場合は0を返します。

pub fn get_object_layer_frame( &self, object: &ObjectHandle, ) -> EditSectionResult<ObjectLayerFrame>

指定のオブジェクトのレイヤーとフレーム情報を取得します。

pub fn get_object_alias( &self, object: &ObjectHandle, ) -> EditSectionResult<String>

オブジェクトの情報をエイリアスデータとして取得します。

pub fn get_object_name( &self, object: &ObjectHandle, ) -> EditSectionResult<Option<String>>

オブジェクト名を取得します。

Returns

標準の名前の場合はNoneを返します。

pub fn set_object_name( &self, object: &ObjectHandle, name: Option<&str>, ) -> EditSectionResult<()>

オブジェクト名を設定します。

Note

nameにNoneや空文字を指定すると、標準の名前になります。

pub fn get_object_effect_item( &self, object: &ObjectHandle, effect_name: &str, effect_index: usize, item: &str, ) -> EditSectionResult<String>

オブジェクトの設定項目の値を文字列で取得します。

Arguments

• object：対象のオブジェクトハンドル。
• effect_name：設定項目の名前。
• effect_index：同じ名前の設定項目が複数ある場合のインデックス（0始まり）。
• item：設定項目の名前。（エイリアスファイルのキーの名前）

pub fn set_object_effect_item( &self, object: &ObjectHandle, effect_name: &str, effect_index: usize, item: &str, value: &str, ) -> EditSectionResult<()>

オブジェクトの設定項目の値を文字列で設定します。

Arguments

• object：対象のオブジェクトハンドル。
• effect_name：設定項目の名前。
• effect_index：同じ名前の設定項目が複数ある場合のインデックス（0始まり）。
• item：設定項目の名前。（エイリアスファイルのキーの名前）
• value：設定する値。

pub fn move_object( &self, object: &ObjectHandle, new_layer: usize, new_start_frame: usize, ) -> EditSectionResult<()>

オブジェクトを移動します。

pub fn delete_object(&self, object: &ObjectHandle) -> EditSectionResult<()>

オブジェクトを削除します。

pub fn get_focused_object(&self) -> EditSectionResult<Option<ObjectHandle>>

現在、オブジェクト設定ウィンドウで選択されているオブジェクトを取得します。

pub fn get_selected_objects(&self) -> EditSectionResult<Vec<ObjectHandle>>

現在選択されているオブジェクトの一覧を取得します。

pub fn focus_object(&self, object: &ObjectHandle) -> EditSectionResult<()>

オブジェクト設定ウィンドウで指定のオブジェクトを選択状態にします。

Note

コールバック処理の終了時に設定されます。

pub fn get_project_file<'handle>( &'handle self, edit_handle: &EditHandle, ) -> ProjectFile<'handle>

プロジェクトファイルのポインタを取得します。

pub fn get_mouse_layer_frame(&self) -> EditSectionResult<Option<LayerFrameData>>

マウス座標のレイヤー・フレーム位置を取得します。

Returns

マウスがレイヤー編集エリア内にある場合は Some を返し、 そうでない場合は None を返します。

pub fn pos_to_layer_frame( &self, x: i32, y: i32, ) -> EditSectionResult<Option<LayerFrameData>>

指定のスクリーン座標のレイヤー・フレーム位置を取得します。

pub fn is_support_media_file<P: AsRef<str>>( &self, file_path: P, mode: MediaFileSupportMode, ) -> EditSectionResult<bool>

指定のメディアファイルがサポートされているかどうか調べます。

pub fn get_media_info<P: AsRef<str>>( &self, file_path: P, ) -> EditSectionResult<MediaInfo>

指定のメディアファイルの情報を取得します。

Note

動画、音声、画像ファイル以外では取得出来ません。

pub fn create_object_from_media_file<P: AsRef<str>>( &self, file_path: P, layer: usize, frame: usize, length: Option<usize>, ) -> EditSectionResult<ObjectHandle>

指定の位置にメディアファイルからオブジェクトを作成します。

Arguments

• file_path：メディアファイルのパス。
• layer：作成するオブジェクトのレイヤー番号（0始まり）。
• frame：作成するオブジェクトのフレーム番号（0始まり）。
• length：作成するオブジェクトの長さ（フレーム数）。Noneを指定した場合、長さや追加位置は自動的に調整されます。

pub fn create_object( &self, effect: &str, layer: usize, frame: usize, length: Option<usize>, ) -> EditSectionResult<ObjectHandle>

指定の位置にオブジェクトを作成します。

Arguments

• effect：エフェクト名。（エイリアスファイルの effect.name の値）
• layer：作成するオブジェクトのレイヤー番号（0始まり）。
• frame：作成するオブジェクトのフレーム番号（0始まり）。
• length：作成するオブジェクトの長さ（フレーム数）。Noneを指定した場合、長さや追加位置は自動的に調整されます。

pub fn set_cursor_layer_frame( &self, layer: usize, frame: usize, ) -> EditSectionResult<()>

現在のレイヤー・フレーム位置を設定します。

Note

設定出来る範囲に調整されます。

pub fn set_display_layer_frame( &self, layer: usize, frame: usize, ) -> EditSectionResult<()>

レイヤー編集のレイヤー・フレームの表示開始位置を設定します。

Note

設定出来る範囲に調整されます。

pub fn set_select_range( &self, start: usize, end: usize, ) -> EditSectionResult<()>

フレーム範囲選択を設定します。

Note

設定出来る範囲に調整されます。

pub fn clear_select_range(&self) -> EditSectionResult<()>

選択されているフレーム範囲選択を解除します。

pub fn set_grid_bpm( &self, tempo: f32, beat: usize, offset: f32, ) -> EditSectionResult<()>

グリッド（BPM）を設定します。

pub fn object_exists(&self, object: &ObjectHandle) -> bool

オブジェクトが存在するかどうか調べます。

Note

内部的には、get_object_layer_frame を呼び出してレイヤー番号が -1 でないかを確認しています。

pub fn layers(&self) -> EditSectionLayersIterator<'_>

すべてのレイヤーをイテレータで取得します。

pub fn layer<'a>(&'a self, layer: usize) -> EditSectionLayerCaller<'a>

EditSectionLayerCaller を作成します。

pub fn object<'a>( &'a self, object: &'a ObjectHandle, ) -> EditSectionObjectCaller<'a>

EditSectionObjectCaller を作成します。

Trait Implementations

impl Debug for EditSection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.