Skip to main content

EditSectionObjectCaller

Struct EditSectionObjectCaller 

Source
pub struct EditSectionObjectCaller<'a, S> {
    pub handle: ObjectHandle,
    /* private fields */
}
Available on crate feature generic only.
Expand description

オブジェクト主体で関数を呼び出すための構造体。 EditSection と ObjectHandle の組をまとめ、対象オブジェクトに対する 操作を簡潔に呼び出せるようにします。

Fields§

§handle: ObjectHandle

Implementations§

Source§

impl<'a, S> EditSectionObjectCaller<'a, S>

Source

pub fn new(edit_section: &'a S, object: ObjectHandle) -> Self

Source§

impl<S> EditSectionObjectCaller<'_, S>
where S: ReadSectionProvider,

Source

pub fn get_layer_frame(&self) -> EditSectionResult<ObjectLayerFrame>

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

Source

pub fn get_alias(&self) -> EditSectionResult<String>

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

Source

pub fn get_alias_parsed(&self) -> EditSectionResult<Table>

Available on crate feature aviutl2-alias only.

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

Source

pub fn count_effect(&self, effect: &str) -> EditSectionResult<usize>

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

§Arguments
  • effect:対象のエフェクト名。(エイリアスファイルの effect.name の値)
§Returns

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

Source

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

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

§Arguments
  • effect_name:設定項目の名前。
  • effect_index:同じ名前の設定項目が複数ある場合のインデックス(0始まり)。
  • item:設定項目の名前。(エイリアスファイルのキーの名前)
Source

pub fn get_effect_item_parsed<T: FromTableValue>( &self, effect_name: &str, effect_index: usize, item: &str, ) -> Result<T, EditSectionParsedError<<T as FromTableValue>::Err>>
where <T as FromTableValue>::Err: Error + Sync + Send + 'static,

Available on crate feature aviutl2-alias only.

オブジェクトの設定項目の値を取得し、パースする。

§See Also

EditSectionObjectCaller::get_effect_item

Source

pub fn exists(&self) -> bool

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

Source

pub fn get_name(&self) -> EditSectionResult<Option<String>>

オブジェクトの名前を取得する。

§Returns

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

Source

pub fn get_section_num(&self) -> EditSectionResult<usize>

オブジェクトの区間の数を取得する。

Source§

impl EditSectionObjectCaller<'_, EditSection>

Source

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

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

§Arguments
  • effect_name:設定項目の名前。
  • effect_index:同じ名前の設定項目が複数ある場合のインデックス(0始まり)。
  • item:設定項目の名前。(エイリアスファイルのキーの名前)
  • value:設定する値。
Source

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

オブジェクトを移動する。

§Arguments
  • new_layer:移動先のレイヤー番号(0始まり)。
  • new_start_frame:移動先の開始フレーム番号(0始まり)。
Source

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

オブジェクトを削除する。

Source

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

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

§Note

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

Source

pub fn set_name(&self, name: Option<&str>) -> EditSectionResult<()>

オブジェクトの名前を設定する。 nameNoneや空文字を指定すると、標準の名前になります。

Trait Implementations§

Source§

impl<S> Deref for EditSectionObjectCaller<'_, S>

Source§

type Target = ObjectHandle

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<'a, S> Freeze for EditSectionObjectCaller<'a, S>

§

impl<'a, S> RefUnwindSafe for EditSectionObjectCaller<'a, S>
where S: RefUnwindSafe,

§

impl<'a, S> Send for EditSectionObjectCaller<'a, S>
where S: Sync,

§

impl<'a, S> Sync for EditSectionObjectCaller<'a, S>
where S: Sync,

§

impl<'a, S> Unpin for EditSectionObjectCaller<'a, S>

§

impl<'a, S> UnsafeUnpin for EditSectionObjectCaller<'a, S>

§

impl<'a, S> UnwindSafe for EditSectionObjectCaller<'a, S>
where S: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more