Blender Sverchok contribute ドキュメントを見る

はじめに

ノードのカスタマイズがしたくなったので関連するっぽいドキュメントを読んでみます

参照元

nortikin/sverchok
Sverchok. Contribute to nortikin/sverchok development by creating an account on GitHub.

Contribute

私達のワークフロー

  1. あなたは自由にコードを書くことができますが、Pep8に従い既存のノードのスタイルを使ってください。あなたが使っているエディターでPyLintが使えるならPep8を使ってください。私達のコードベースから”Pyling ignore”を検索してください、そこに私たちが日常的に意識的に無視するルールがあるからです。しかしPep8 の大部分は純金であり、あなたのコードを受け入れるためのパスの一部です。
  2. アジャイルソフトウェア開発 – http://en.wikipedia.org/wiki/Agile_software_developmentを見てください
  3. 適切なライセンス (GPL) と書面による同意や権利があれば、他のアドオンからアイデアを実装しても構いません。あなたが書いていない無属性のコードは受け付けません。
  4. 何かを作成するために多くの時間を費やす前に、前もって私達に伝えることをおすすめします。時にすでに存在している場合もあったり、すでにそのことについて計画している場合があります。
  5. ブレインストーミングを行い、解決策を議論します。私たちはイシュートラッカーをよく利用しており、新しいコードの正直な意見や解釈を提供します。私たちはアーティストであり技術者であり、コードとBlenderを使って複雑で興味深い問題を解決しようとしています。私たちは最適なコードに関心を持っていますが、作業中のものや斬新な解決策も受け入れています。
  6. あなたのコードをテストし、提案された変更点をテストします。意味のあるときにはいつでもあなたのコードの自動テストを書いてください。詳細はこちらのドキュメントを参照してください。

してはいけないこと

これらのことを行うと古いレイアウトが壊れたり意図しない結果となります

  • ノードのbl_idnameの変更
  • ソケットの削除またはリネーム
  • upgrade.pyの更新をせずに既存のソケットの間に新しいソケットを追加する。self.inputsまたはself.outputsにソケットを追加する時は末尾に追加する事を私達は好みます
  • ノードプロパティのcurrent_mode予約語です。使用しないでください
  • 他にも予約されたプロパティ名があり、Blenderのドキュメントのbpy.types.Node baseclassや、Sverchokのカスタムノードミキシンクラスを参照してください。

役に立つヒント

BlenderコンソールでSverchokシステムを簡単にインスペクトできます

import sverchok
print(dir(sverchok.nodes))

ノードを作成する

  1. イデアをテストするためにスクリプトノードで作成する
  2. issueまたはブランチを作成、またはマスタをフォークして私達にそれを見せてください。もしそれがかなり複雑であれば協力者として協力して貰う場合があります。
  3. 類似した既存のノードをコピーし、それをベースとして開始する
  4. クラス名、bl_idname、docstring、そして登録セクションを変更
  5. bl_idnameをmenu.pyの適切なカテゴリへ追加
  6. マッチしたカテゴリへファイルを追加: ..sverchok/nodes/whatever_existing_category/your_file.py
  7. Pullリクエストの作成

いくつかの規則

  1. 全てのクラスは Blenderクラスのサブクラスです。接頭辞に Svを付けてください。例えば SvColor
  2. node_tree.pyはノードツリーのベースクラスを含みます、おそらくコレクションプロパティまたは新しいソケットを生成するでしょう。ここから作成してください。(全くの新しいタイプのソケットの場合はまず教えて下さい)
  3. data_structure.pyは次のような魔法があります:
    1. 定義の更新。これはソケットとノードの更新にかなりよく動作しています
    2. いくつかのbmesh関数
    3. cache ハンドルを使って操作する。私達はノードデータを操作するために使用します。これは辞書でノード名、ノードツリー名とデータをもっています
    4. レベル定義をリストアップします。必ず使用する必要があります
      1. データ修正によってカオスなデータから4次元レベルのリストを作成します。f/iまたは[[f/i]]ではなく[floats/integers]のようになります
        • usage: dataCorrect(data, nominal_dept=2)
      2. データスポイル – 深さの値のためにリストを台無しにする
        • usage: dataSpoil(data, dept)
      3. リストのレベル – ネストレベルを調べる
        • usage: levelsOflist(list) – リストのレベルを返す [] は2, [[]]は3
    5. マトリックス定義 – matrics/verticesで何かを作る。色々書いてあるが難解すぎて難しい
    6. リスト定義色 色々書いてあるが難解すぎて難しい
    7. ソケット更新 – ノード内で変更可能なソケットを使用できるようにする。色々書いてあるが難解すぎて難しい
    8. 複数ソケット multi_socket(node, min=1) ListJoin、ListZip、ConnectUVなどで使用している。色々書いてあるが難解すぎて難しい
  4. Utilsフォルダーには下記があります
    1. CADmodule – 線の交差を提供する
    2. indexViewerDraw – INDX viewノードのOpenGL描画を提供する
    3. sv_bmeshutils
    4. sv_tools – これは、更新ボタン、アップグレードボタン、およびレイヤー表示ボタンのノード領域のツールボックスです。また、このプロセスを自動化するためにノードとアップグレード機能を更新します。
    5. text_editor_plugins
    6. text_editor_submenu – SNのテンプレート
    7. upgrade – 古いレイアウトを壊さないようにするため。。新しい簡略化されたインターフェースのオーバーライドを定義します。draw_buttons()でなにかのプロパティを変更した場合、古いレイアウトを壊さないようにここに新しいプロパティを持ってくる。
    8. viewer_draw – ViewerDrawのOpenGLを扱ったり描画したりする為。
    9. voronoi – 対応するノードのボロノイまたは泥ねーの為
  5. Node scripts フォルダーはすべてのSNのテンプレートの為のもの(utils-eを見てください)
  6. Nodes フォルダーはカテゴライズされたノードの為のもの。 init.pyにアタナのノードを記載するのを忘れないようにしてください
  7. enumerateプロパティを使用するには、アイテムにインデックスを割り当てる必要があります。追加されたアイテムのインデックスは変更しないでください。
    さらに機能を追加すると機能しなくなります。
  8. 多機能でなくても達成できる多くのノードを作らないでください
  9. レベルを使ってください。それがどのように動作するかを知ってください。drawにあるlevel intPropertyを使って操作するレベルを定義してください。私達は標準で1,2,3、そして追加の4を操作します。あなたのレベルが制限されている事を確認してください。levelsOflistによって最大値としてドロップダウンされていることを確認してください
  10. 出力と同様にノードの定義更新の順番を保ってください。出力ソケットが組み立てられている場合のみ入力をカウントします
  11. Todoリストを見て現在何が起きているか、また何ができるかを知ってください。あなたのノードを使いテストしてください
  12. 他のノードで進めるのに必要以上に自動でラッピングしたり、ラッピングのレベルを低くしたりする理由はありません。今の所、単純なデータの場合は0,1,2,3となり。辺、頂点、マトリックス等の実データは[0,1,2,3]やよりネストされた形になります。しかし少なくないネストとラッピングは根拠のある理由を提示する必要があります
  13. ソケットがupdate(self)でリンクされているかどうかテストするためにis_linkedを使わないでください。process(self)がis_linkedを使っています。
  14. ノードを変更するには次に従ってください
    1. 古いノードファイルを./old_nodesに置いて、init.pyの中の対応するbl_idnameをテーブルに追加します。(READMEファイルもあります)。
    2. 新しい変更されたノードを mk2(3,4…n) として作成し、すべての変更を新しいノード、変更名、bl_idname として古いノードが置かれた場所に配置します (現在のインストラクションの ‘To create a node:’ を参照してください)。

最後に

半分以上意味がわからなかった。ハードルが高い

コメント

タイトルとURLをコピーしました