mxsdoc

依存

• std

struct MwmConditionStruct

プロパティ値の条件式を定義する構造体。

補足

作成パラメータ

MwmConditionStruct evaluator

通知

通知名	通知データ	タイミング
#ConditionChanged	新たなプロパティオブジェクトの値	プロパティオブジェクトの値が変更された後
#Evaluator	新たなevaluator値	evaluatorを設定した後
#Properties	新たなproperties値	propertiesを設定した後

オブザーバ

購読先	メソッド
propertiesに追加したプロパティオブジェクト	PropertyValueChanged

public _CP1_

プロパティ

<MAXScriptFunction>

作成パラメータ1。条件式を定義した関数。既定値はundefined。

private evaluator

プロパティ

<MAXScriptFunction>

条件式を定義した関数。既定値はundefined。

private properties

プロパティ

<Array[<Struct:MwmPropertyStruct>]>

条件となるプロパティオブジェクト。既定値は#()。

public fn AddProperty

条件となるプロパティオブジェクトを追加する。

パラメータ

property

<Struct:MwmPropertyStruct>

プロパティオブジェクト。

戻り値

<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合は何もしない。

public fn Evaluate

条件式を評価する。

戻り値

<Any>

public fn GetEvaluator

条件式を定義した関数を取得する。

戻り値

<MAXScriptFunction|UndefinedClass>

public fn GetProperties

条件となるプロパティオブジェクトを全て取得する。

戻り値

<Array[<Struct:MwmPropertyStruct>]>

public fn GetProperty

条件となるプロパティオブジェクトを取得する。

パラメータ

propertyName

<Name>

プロパティ名。

戻り値

<Struct:MwmPropertyStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn GetPropertyNames

条件となるプロパティオブジェクトのプロパティ名を全て取得する。

戻り値

<Array[<Name>]>

public fn HasProperty

条件となるプロパティオブジェクトが登録済みかどうかを判定する。

パラメータ

key

<Struct:MwmPropertyStruct|Name>

プロパティオブジェクトまたはプロパティ名。

戻り値

<BooleanClass>

public fn MakeParams

登録したプロパティオブジェクトからプロパティ名とプロパティ値のペアの配列を作成する。

戻り値

<Array[<DataPair Name:<Name> Value:<Any>>]>

public fn PropertyValueChanged

登録したプロパティオブジェクトの変更通知を発行する。

パラメータ

type

<Name>

パラメータ

param

<Any>

戻り値

<OkClass>

public fn RemoveProperty

条件となるプロパティオブジェクトを除去する。

戻り値

<BooleanClass>

除去に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合は何もしない。

public fn SetEvaluator

条件式を定義した関数を設定する。

パラメータ

input

<MAXScriptFunction>

戻り値

<MAXScriptFunction|UndefinedClass>

補足

無効な値の場合は何もしない。
指定する関数は次のように実装する。

fn exampleEvaluator params = (
  params.Count == 2 \
      and params[1].Name == #Foo and params[1].Value == 0 \
      and params[2].Name == #Bar and params[2].Value == 1
)

• 引数はプロパティ名とプロパティ値のペアの配列を一つ取る。

  引数	型
  params	<Array[<DataPair Name:<Name> Value:<Any>>]>

private fn findProperty

プロパティを検索する。

パラメータ

property

<Struct:MwmPropertyStruct>

戻り値

<Integer>

private fn findPropertyByName

プロパティ名でプロパティを検索する。

パラメータ

propertyName

<Name>

戻り値

<Integer>

private fn isValidFunction

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidProperty

パラメータ

obj

<Any>

戻り値

<BooleanClass>

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

大文字と小文字を区別する。

public StateChanged

プロパティ

<Struct:ObservableStruct>