class cymel.core.cyobjects.transform_c.TransformMixin

Inheritance diagram of TransformMixin
class cymel.core.cyobjects.transform_c.TransformMixin

ベースクラス: object

Transform クラスでサポートする機能の中核。

Methods:

setM(m[, ws, safe, get])

setMatrix の別名。

setMatrix(m[, ws, safe, get])

マトリックスをセットする。

setQ(q[, ws, ra, r, jo, safe, get])

setQuaternion の別名。

setQuaternion(q[, ws, ra, r, jo, safe, get])

ノードの回転のクォータニオンをセットする。

setS(v[, ws, safe, get])

setScaling の別名。

setScaling(v[, ws, safe, get])

ノードのスケーリングの値をセットする。

setSh(v[, ws, safe, get])

setShearing の別名。

setShearing(v[, ws, safe, get])

ノードのシアーの値をセットする。

setT(v[, ws, at, safe, get])

setTranslation の別名。

setTransformation(x[, ws, safe, get])

トランスフォーメーションをセットする。

setTranslation(v[, ws, at, safe, get])

ノードの位置をセットする。

setX(x[, ws, safe, get])

setTransformation の別名。

Methods Details:

setM(m, ws=False, safe=False, get=False)

setMatrix の別名。

setMatrix(m, ws=False, safe=False, get=False)

マトリックスをセットする。

ws=True の場合は、 setQuaternion の ra=True 、 setScalingsetShearing そして setTranslation の at=4 を順番に全て行った結果と一致する (Scaling と Shear の順序は問わないが、 他はこの順序で行う必要がある)。

ws=False の場合は、 joint のセグメントスケール補正が効いていると、 setTranslation 以外は一致しない。

パラメータ:
  • m (Matrix) -- セットしたいマトリックス。

  • ws (bool) -- ワールド空間でセットするかどうか。

  • safe (bool) -- アトリビュートがロックされていているなどのために セットできない場合もエラーにならない。 また、 double3 のセットできる箇所だけセットされる。

  • get (bool) -- 実際にはセットせず、 セットされるべきアトリビュート値だけ計算する。

戻り値の型:

Transformation or None

setQ(q, ws=False, ra=False, r=True, jo=True, safe=False, get=False)

setQuaternion の別名。

setQuaternion(q, ws=False, ra=False, r=True, jo=True, safe=False, get=False)

ノードの回転のクォータニオンをセットする。

デフォルトでは rotateAxis を含んでいない回転となり、 マトリックスからの分解結果とは一致しないが、 Maya の機能(Local Axis 表示やコンストレイン)が ノードの回転方向とする基準と一致する。

ws=False の場合は、 3種の回転アトリビュートのみから合成された値を意味し、 joint ノードのローカルマトリックスには含まれる inverseScale の影響は無視される。

セットするアトリビュートは通常は rotate だが、 r=False の場合は、他のオプションによって jointOrient か rotateAxis になる。

パラメータ:
  • q (Quaternion) -- セットしたいクォータニオン。

  • ws (bool) -- ワールド空間でセットするかどうか。

  • ra (bool) -- rotateAxis を含んでいるかどうか。

  • r (bool) -- rotate を含んでいるかどうか。

  • jo (bool) -- jointOrient を含んでいるかどうか。

  • safe (bool) -- アトリビュートがロックされていているなどのために セットできない場合もエラーにならない。 また、 double3 のセットできる箇所だけセットされる。

  • get (bool) -- 実際にはセットせず、 セットされるべき rotate アトリビュート値だけ計算する。

戻り値の型:

list or None

警告

以下のオプションの組み合わせはエラーになる。

  • ws=False, ra=True, r=False, jo=True

  • ws=True, jo=False

  • ws=True, ra=True, r=False

  • ws=True, r=False で joint ではない場合

setS(v, ws=False, safe=False, get=False)

setScaling の別名。

setScaling(v, ws=False, safe=False, get=False)

ノードのスケーリングの値をセットする。

ws=False の場合は、 単に scale アトリビュートの値を意味し、 joint ノードのローカルマトリックスには含まれる inverseScale の影響は無視される。

パラメータ:
  • v (sequence) -- セットしたい scale 値。

  • ws (bool) -- ワールド空間でセットするかどうか。

  • safe (bool) -- アトリビュートがロックされていているなどのために セットできない場合もエラーにならない。 また、 double3 のセットできる箇所だけセットされる。

  • get (bool) -- 実際にはセットせず、 セットされるべき scale アトリビュート値を得る。

戻り値の型:

list or None

警告

セグメントスケール補正されていない非一様スケーリングや シアー変換が上位に存在する場合は、 このノードの回転の影響も受けるため、 先に回転をセットしなければならない。

setSh(v, ws=False, safe=False, get=False)

setShearing の別名。

setShearing(v, ws=False, safe=False, get=False)

ノードのシアーの値をセットする。

ws=False の場合は、 単に shear アトリビュートの値を意味し、 joint ノードのローカルマトリックスには含まれる inverseScale の影響は無視される。

パラメータ:
  • v (sequence) -- セットしたい shear 値。

  • ws (bool) -- ワールド空間でセットするかどうか。

  • safe (bool) -- アトリビュートがロックされていているなどのために セットできない場合もエラーにならない。 また、 double3 のセットできる箇所だけセットされる。

  • get (bool) -- 実際にはセットせず、 セットされるべき shear アトリビュート値だけ計算する。

戻り値の型:

list or None

警告

セグメントスケール補正されていない非一様スケーリングや シアー変換が上位に存在する場合は、 このノードの回転の影響も受けるため、 先に回転をセットしなければならない。

setT(v, ws=False, at=2, safe=False, get=False)

setTranslation の別名。

setTransformation(x, ws=False, safe=False, get=False)

トランスフォーメーションをセットする。

ピボットや jointOrient などの修飾系アトリビュートも 一通りセットされる。

joint ノードと transform ノードの トランスフォーメーションのコピーで、 相互に互換性の無いアトリビュートがある場合 (ピボット系、segmentScaleCompensate、jointOrientなど)、 マトリックスが一致するようにセットされる。

joint ノードではピボット系アトリビュートは サポートされないものとして扱うが shear は利用する。

パラメータ:
  • x (Transformation) -- セットしたいトランスフォーメーション情報。

  • ws (bool) -- ワールド空間でセットするかどうか。

  • safe (bool) -- アトリビュートがロックされていているなどのために セットできない場合もエラーにならない。 また、 double3 のセットできる箇所だけセットされる。

  • get (bool) -- 実際にはセットせず、 セットされるべきアトリビュート値だけ計算する。

戻り値の型:

Transformation or None

setTranslation(v, ws=False, at=2, safe=False, get=False)

ノードの位置をセットする。

デフォルトでは回転ピボットの位置を意味し、 マトリックスからの分解結果とは一致しないが、 Maya の機能(Local Axis 表示位置やコンストレイン)が ノードの位置とする基準と一致する。

パラメータ:
  • v (sequence) -- セットしたい位置。

  • ws (bool) -- ワールド空間でセットするかどうか。

  • at (int) --

    どのアトリビュートに相当する位置でセットするか。

    • 0 だとローカル原点(親の matrix 位置)。

    • 1 だと translate の位置。

    • 2 だと rotatePivot の位置。

    • 3 だと scalePivot の位置。

    • 4 以上だと matrix の位置。

  • safe (bool) -- アトリビュートがロックされていているなどのために セットできない場合もエラーにならない。 また、 double3 のセットできる箇所だけセットされる。

  • get (bool) -- 実際にはセットせず、 セットされるべき shear アトリビュート値だけ計算する。

戻り値の型:

list or None

警告

at=4 の場合、 setScalingsetShearingsetQuaternion の後で呼び出す必要がある。 そうしないと、ピボットがローカル原点にない場合に それらによって位置が変わってしまう。

setX(x, ws=False, safe=False, get=False)

setTransformation の別名。