CustomOperator.AddInputPortByClassID

導入

v5.1

詳細

カスタムオペレータにInputPortを追加します。このメソッドを使用すると、既存のオブジェクトを指定するのではなく、接続が必要なオブジェクトのタイプを指定することにより、カスタムオペレータへの接続を定義できます。

これは、ポートがオプションで、オペレータのインスタンスが作成された後に動的に接続されるような、高度なオペレータで使用されます。この方法で定義された各方法は、独自のPortGroupを持つため、接続はOperator.ConnectToGroupを使用して構築できます。

たとえば、オペレータでClusterPropertyへの任意の接続がサポートされている場合、ある時点まではそのオペレータが ClusterProperty に接続するためのものでなくても、オペレータが定義されるときにCustomOperator.AddInputPortメソッドが ClusterProperty を強制的に存在させます。この方法を使用すると、シーンに ClusterProperty を実際に存在させる必要がなくなります。

C#構文

InputPort CustomOperator.AddInputPortByClassID( siClassID in_TargetClassID, String in_PortName, Int32 in_portgroup, Int32 in_flags );

スクリプト構文

oReturn = CustomOperator.AddInputPortByClassID( TargetClassID, [PortName], [PortGroup], [Flags] );

戻り値

新しく作成されたInputPort

パラメータ

パラメータ タイプ 説明
TargetClassID siClassID このオブジェクトに接続できるオブジェクトのタイプです。たとえば、siKinematicStateID、siClusterPropertyID、siParameterID、siPrimitiveID などがあります。
PortName String ポートの名前。

デフォルト値: デフォルト名は「In」+ 接続するオブジェクトの Parameter.ScriptName です。たとえば、「Inposx」などになります。

PortGroup Long ポートグループのインデックス

デフォルト値: -1

Flags Long siPortFlags により記述されたポートグループフラグのマスク

デフォルト値: 0

関連項目

CustomOperator.AddInputPort CustomOperator.AddOutputPortByClassID Operator.ConnectToGroup