showInterface 調査関数

インタフェース

コア インタフェース

その他のインタフェース

showInterface <interface> [ to:<stream> ]     

<interface> は調査対象のインタフェースです。

オプションの to:<stream> キーワードの引数には、表示内容を出力するストリーム値を指定します。

この関数は、パラメータとして指定されているインタフェースのインタフェース情報を表示します。

インタフェース情報の表示は、Properties、Methods、Actions の 3 つのセクションに分けられます。

Properties セクションでは、インタフェースによって公開されたプロパティがそのデータ型または列挙値とともに一覧表示されます。また、そのプロパティが読み書き可能かどうかも表示されます。

Methods セクションには、各メソッドが、返されるタイプおよび引数のリストとともに表示されます。各引数の値のタイプも表示されます。返されるタイプが <void> と表示される場合、メソッドは値 'ok' を返します。Action によって使用されるメソッドについては、そのことがコメントとして記載されます。一般に、これらのメソッドを使用する場合、適切なコマンド パネルでオブジェクトが選択されアクティブになっている必要があります。

Actions セクションでは、各アクションとともに、[ユーザ インタフェースをカスタマイズ]ダイアログ ボックスに表示されるカテゴリおよびアクションの説明、およびショートカット キー(アクションにショートカット キーが割り当てられている場合)が表示されます。

例

    ctrl = lookat_constraint() --create a new lookat constraint
    showinterface ctrl.constraints --show the constraints interface

結果:

    Interface: constraints
    Properties:
    Methods:
    <index>getNumTargets()
    <node>getNode <index>targetNumber
    <float>getWeight <index>targetNumber
    <boolean>setWeight <index>targetNumber <float>weight
    <boolean>appendTarget <node>target <float>weight
    <boolean>deleteTarget <index>targetNumber
    Actions:

showInterface 関数を getInterfaces 関数と組み合わせれば、showInterfaces 関数から使用した場合と同様に、MAXWrapper または MAXClass によって公開されるインタフェースの配列を出力することができます。