class cymel.core.cyobjects.constraint.Constraint

Inheritance diagram of Constraint
class cymel.core.cyobjects.constraint.Constraint(*args, **kwargs)

ベースクラス: Transform

constraint

固定引数無しでのクラスインスタンス生成時のノード生成をサポート。

Methods:

getTargetList()

Return the list of target objects.

getWeight(*targetObjects)

Returns the weight value for the specified targetObject(s).

getWeightAliasList()

Returns the names of the attributes that control the weight of the target objects.

getWeightPlugList()

Returns the plug that control the weight of the target objects.

newObject(data)

内部データとともにインスタンスを生成する。

setWeight(weight, *targetObjects)

Sets the weight value for the specified targetObject(s).

Methods Details:

getTargetList()

Return the list of target objects.

戻り値の型:

list[Constraint]

getWeight(*targetObjects)

Returns the weight value for the specified targetObject(s). if targetObjects are not provided, this will get weights of all targets

パラメータ:

targetObjects -- target nodes of this constraint

戻り値の型:

float or list[float]

getWeightAliasList()

Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same order as the targets are returned by the targetList flag

戻り値の型:

list[str]

getWeightPlugList()

Returns the plug that control the weight of the target objects. Plugs are returned in the same order as the targets are returned by the targetList flag

戻り値の型:

list[plug]

classmethod newObject(data)

内部データとともにインスタンスを生成する。

内部データはブラックボックスであるものとし、 本メソッドをオーバーライドする場合も、 基底メソッドを呼び出して処理を完遂させなければならない。

内部データを拡張する場合は internalData も オーバーライドすること。

パラメータ:
  • cls (type) -- 生成するインスタンスのクラス。

  • data -- インスタンスにセットする内部データ。

戻り値の型:

指定クラス

setWeight(weight, *targetObjects)

Sets the weight value for the specified targetObject(s). if targetObjects are not provided, this will set weights for all targets

パラメータ:
  • weight (float) -- weight value to set for given target

  • targetObjects -- target nodes of this constraint