PDGデータレイヤーまたは PDGD は、PDGデータにアクセスする別の手段です。

PDGDは、定期購読ベースのシステムです。 つまり、PDGDを使用することで、PDGオブジェクトを Subscribe(定期購読) し、そのオブジェクトのデータを Watch(監視) し、自動更新を介してそのオブジェクトのデータの変更内容を Report(報告) することができます。

PDGオブジェクトのデータにアクセスできるようにするには、まず最初に、そのオブジェクトの ビジュアライザ を作成してから、そのオブジェクトの サブスクリプション を作成する必要があります。

import pdgd.util 

data_layer = pdgd.util.get_local_data_layer() 
visualizer_object = pdgd.util.PDGDObject('pdg/object/path', data_layer)

def my_callback(pdg_object_path, object, message): 
        pass

# この段階でvisualizer_objectが既にデータを受け取っていることに気づくことが重要です。 
# その初期データを処理する必要がある場合は、一度手動でmy_callbackをコールする必要があります。

visualizer_object.addListener(my_callback)

pdgd.util.PDGDObjectクラスは、PDGDとの通信を抽象化します。 このクラスからPDGDオブジェクトを作成するとすぐに、そのオブジェクトがSubscribe(定期購読)され、そのオブジェクトの内部表現が構築され、すべてのデータがPythonタイプに変換されます。 この オブジェクトメンバー を使用することで、いつでもこの内部表現にアクセスすることができます。 さらには、Listener関数をPDGDObjectに登録することができます。 Listener関数は、そのオブジェクトのデータが変更される度に発動されます。

PDGDプロパティ名は、graph_listやidといった単純な文字列になっています。 将来のバージョンのPDGDと互換性を維持できるようにするために、これらのプロパティ名はpdgd.PropertyNamesを介して公開しています。 そのため、graph_listなどのプロパティ名を直接使用するのではなく、代わりにpdgd.PropertyNames.GraphListを使用することを推奨します。

現行Houdiniインスタンスで作成されたすべてのPDGグラフを追跡するハイレベルなPDGオブジェクトが存在します。 このハイレベルなPDGオブジェクトのパスがpdgです。

import pdgd.util

data_layer = pdgd.util.get_local_data_layer() 
visualizer_object = pdgd.util.PDGDObject('pdg', data_layer) 

print(visualizer_object.object)

上記のサンプルは、graph_listプロパティを含んだ辞書をプリントします。 このプロパティは、現行Houdiniインスタンスで作成されたすべてのPDGグラフのリストです。 新しいTOPネットワークを作成すると、このオブジェクトは、その新しいグラフがそのリストに含まれるように更新します。

graph_listプロパティには、グラフ名のリストが格納されています。 これらのグラフ名をpdg/{graph_name}の書式で使用することで、グラフオブジェクトパスを構築することができます。

import pdgd 
import pdgd.util

GRAPH_LIST_KEY = pdgd.PropertyNames.GraphList

data_layer = pdgd.util.get_local_data_layer()
visualizer_object = pdgd.util.PDGDObject('pdg', data_layer)

graph_objects = {} 

if GRAPH_LIST_KEY in visualizer_object.object: 
    for graph_name in visualizer_object.object[GRAPH_LIST_KEY]: 
        graph_objects[graph_name] = pdgd.util.PDGDObject('pdg/' + graph_name, data_layer) 

pdg/{graph_name}/node_{node_id}の書式を使用することで、PDGノードにアクセスすることができます。

PDGノードは、PDGグラフが所有していて、そのPDGグラフをSubscribe(定期購読)することでノードIDリストを取得することができます。

pdgd.PropertyName.NodeListプロパティには、ノードオブジェクトパスの構築に使用可能なIDのリストが格納されています。

pdg/{graph_name}/work_item_{work_item_id}の書式を使用することで、ワークアイテムにアクセスすることができます。

PDGワークアイテムは、PDGグラフが所有していて、そのPDGグラフをSubscribe(定期購読)することでワークアイテムIDリストを取得することができます。

pdgd.PropertyNames.WorkItemsプロパティには、ワークアイテムオブジェクトパスの構築に使用可能なIDのリストが格納されていて、 各リストには、PDGグラフ内のすべてのワークアイテムが格納されています。 PDGノードオブジェクトにもpdgd.PropertyNames.WorkItemsプロパティがありますが、そのリストにはそのPDGノードのワークアイテムのみが格納されています。

ビジュアライザは、データにアクセスできるようにメッセージを処理します。 各メッセージは、オブジェクトのデータに起きている内容をビジュアライザに伝えます。 このメッセージは、オブジェクトのフル状態を保持した スナップショットメッセージ 、または、特定のプロパティがどのように変更されたかを示した 差分(Delta)メッセージ のどれかです。

Python APIはpdgd.Messageクラスを公開しています。

getTypeメソッドをコールすることで、メッセージの タイプ を確認することができます。 返される値は以下のどれかです:

• pdgd.Message.MessageType.eMessageTypeObjectSnapshot

• pdgd.Message.MessageType.eMessageTypeAppendValues

• pdgd.Message.MessageType.eMessageTypeRemoveValues

• pdgd.Message.MessageType.eMessageTypeSetValues

toPython()メソッドをコールすることで、すべてのメッセージデータをPythonタイプに変換することもできます。 このメソッドによって、メッセージが扱いやすくなり、さらにはC++コードのコールを少なくすることができます。

スナップショットメッセージには、オブジェクトのすべてのワークアイテムのプロパティとアトリビュートに関する情報が含まれています。 ほとんどのオブジェクトは、新しいサブスクリプションを追加するとすぐにスナップショットメッセージの送信を開始します。

getObjectSnapshot()メソッドをコールすることで、pdgd.ObjectSnapshotインスタンスを返すことができます。

差分(Delta)メッセージには、特定のオブジェクトのプロパティに関する情報とその値がどのように変更されたのかを示した情報が含まれています。

getPropertyName()メソッドをコールすることで、どのプロパティが変更されたのかを調べることができます。

他にも、getPropertyArray()メソッドをコールすることで、変更された値のリスト(メッセージタイプは、その値のリストの意味を決めます)を取得することができます。

pdgd.util.SimpleHandlerは、新しいサブスクリプションハンドラーの作成に使用可能な基底クラスです。 pdgd.util.PDGDObjectと同様に、この基底クラスは、PDGDコードの上層にある抽象レイヤーです。

import pdgd 
import pdgd.util 

class MySubscriptionHandler(pdgd.util.SimpleHandler):

        def __init__(self, handler): 
                super(MySubscriptionHandler, self).__init__(handler) 

                self.addValues('TestProperty', [0, 1, 2, 3, 4]) 
                self.addValues2('TestProperty2', ["test_string"]) 

pdgd.util.register_new_handler(MySubscriptionHandler, 'MySubscriptionHandlerName', ' my_subscription_handler_address') 

data_layer = pdgd.util.get_local_data_layer() 
visualizer_object = pdgd.util.PDGDObject(data_layer, 'my_subscription_handler_address')

上記のサンプルでは、独自のサブスクリプションハンドラーを定義してから、pdgd.util.PDGDObjectを使用してそのハンドラーをSubscribe(定期購読)しています。

pdgd.util.register_new_handlerメソッドは3つのパラメータを受け取ります:

• サブスクリプションハンドラー定義。

• このタイプのハンドラーのインスタンス化に使用される名前。

• (オプション)PDGDがそのサブスクリプションハンドラーのインスタンスを作成するパス。

import pdgd 
import pdgd.util

class MySubscriptionHandler(pdgd.util.SimpleHandler):

        def __init__(self, handler): 
                super(MySubscriptionHandler, self).__init__(handler) 

        @pdgd.util.SimpleHandler.command('MyCommand') 
        def my_command(self, params): 
                print('MyCommand command called with parameters: {}'.format(params)

pdgd.util.register_new_handler(MySubscriptionHandler, 'MySubscriptionHandlerName', 'my_subscription_handler_address')

data_layer = pdgd.util.get_local_data_layer() 
data_layer.sendCommand('MyCommand', 'Parameter', 'my_subscription_handler_address') 

サブスクリプションハンドラーは子ハンドラーインスタンスを持つことができます。 SubscriptionHandlerManagerインスタンスを使用することで、新しいサブスクリプションハンドラーを作成することができます。

import pdgd 
import pdgd.util 

class MySubscriptionHandler(pdgd.util.SimpleHandler): 

        def __init__(self, handler): 
                super(MySubscriptionHandler, self).__init__(handler) 

                this_handler_name = self.getObjectName() 
                child_handler_name = 'child' child_handler_path = '{}/{}'.format( 
                        this_handler_name, child_handler_name)

                handler_manager = pdgd.SubscriptionHandlerManager.Instance() 
                child_handler = handler_manager.createSubscriptionHandler(child_handler_path, 'MySubscriptionHandlerName') 

                self.addChildHandler(child_handler_name, child_handler)

pdgd.util.register_new_handler(MySubscriptionHandler, 'MySubscriptionHandlerName') 

PDGDで以下のオブジェクトが存在すると仮定します:

{ 
        'obj_a': { 
                'prop_a': [1, 3, 5]
        },
        'obj_b': { 
                'my_children_ids': [0, 1, 2, 3, 4, 5, 6, 7]
        }, 
        'obj_b/child0': { 'my_filter_prop': 0 },
        'obj_b/child1': { 'my_filter_prop': 1 },
        'obj_b/child2': { 'my_filter_prop': 2 },
        'obj_b/child3': { 'my_filter_prop': 3 },
        'obj_b/child4': { 'my_filter_prop': 0 },
        'obj_b/child5': { 'my_filter_prop': 1 },
        'obj_b/child6': { 'my_filter_prop': 2 },
        'obj_b/child7': { 'my_filter_prop': 3 } 
} 

obj_bの子オブジェクト内のobj_aのprop_aプロパティで表現されたサブセットのうち、my_filter_propが 1 のサブセットに興味があるのであれば、以下のクエリを構築すると良いでしょう:

import pdgd 
import pdgd.util 

query_string = 
""" 
query? 
{ 
    'property_paths': [ 
            'obj_a/prop_a',
    ],
    'format_string': 'obj_b/child{}',
    'filters': [ 
        [{ 
            'property_name': 'my_filter_prop',
            'filter_value': 1, 
            'negate': false 
        }] 
    ] 
} 
""" 

data_layer = pdgd.util.get_local_data_layer() 
query_visualizer = pdgd.util.PDGDObject(query_string, data_layer) 

上記のサンプルでは、クエリが他のPDGDオブジェクトと同じように動作します。 このクエリに影響を与えるデータが変更される度に、結果がどのように変更されたのかを示したメッセージが送信されます。