(vrBaseService を継承)
VRED でライト、ライト セット、レンズ フレアにアクセスするためのインタフェース。
これは、ライト、ライト セット、レンズ フレアへのアクセス、これらの作成、または削除を行うための基本インタフェースです。vrLightService.getLightRoot() を使用してライト グラフにアクセスする機能も提供します。
次に、ライトの使用方法の例をいくつか示します。
# add a group node
groupNode = vrLightService.createLightGroup("group node")
# create a point light below the group pointLight = vrLightService.createLight("point light", vrLightTypes.LightType.Point, groupNode)
# find a light node in the main scene graph pointLight = vrNodeService.findNode("point light")
# find a light node in the light graph pointLight = vrLightService.findLight("point light")
# copy lens flares from pointLightNode1 to pointLightNode2 # this creates an actual copy of the vrdLensFlareEffect and stores it vrLightService.copyLensFlare(pointLightNode1.getLensFlareEffect()) vrLightService.pasteLensFlare([pointLightNode2])
# delete the pointlight and the group vrNodeService.removeNode([pointLight, groupNode])
vrLightService.convertLight(lightNode, lightType)ライト ノードを別のタイプのライトに変換します。注意: この操作を行うと、このノード オブジェクトは無効になります。
| パラメータ: |
|
|---|
vrLightService.convertLights(nodes, lightType)ライト ノードを別のタイプのライトに変換します。注意: この操作を行うと、これらのノード オブジェクトは無効になります。
| パラメータ: |
|
|---|
vrLightService.copyLensFlare(effect)コピー バッファにレンズ フレアの効果を追加します。
| パラメータ: | effect (vrdLensFlareEffect): コピーするためにクリップボードに追加されたレンズ フレアの効果。 |
|---|
vrLightService.copyLensFlareElements(elements)コピー バッファにレンズ フレアを追加します。
| パラメータ: | elements (List[vrdLensFlareElement]): コピーするすべてのレンズ フレア |
|---|
vrLightService.copyLensFlareGhosts(ghosts)すべてのゴーストをコピー バッファにコピーします。
| パラメータ: | ghosts (List[vrdLensFlareGhost]): コピーするすべてのゴーストのリスト |
|---|
vrLightService.copyLights(nodes)ライト グラフ内の指定したすべてのライト ノードをクリップボードにコピーします。クリップボードは、新しいコピーの前に毎回クリアされます。
| パラメータ: | nodes (List[vrdNode]): コピーするすべてのライト ノードのリスト |
|---|
vrLightService.createLight(name, type, parent=vrdNode())ライト グラフ内に新しいライト ノードを作成します。
| パラメータ: |
|
|---|---|
| 戻り値: | ライト グラフ内の、新しく作成および追加されたライト ノード。 |
| 戻り値の型: |
vrLightService.createLightGroup(name, parent=vrdNode())新しいライト グループを作成します。
| パラメータ: |
|
|---|---|
| 戻り値: | 新しく作成されたグループ ノード |
| 戻り値の型: |
vrLightService.createLightGroup(name, nodes)いくつかのライトから新しいライト グループを作成します。
| パラメータ: |
|
|---|---|
| 戻り値: | 新しく作成および追加されたライト グループ ノード |
| 戻り値の型: |
vrLightService.createLightLinkSet(name='')新しいライト リンク セットを作成します。
| パラメータ: | name (string): ライト リンク セットの名前。名前を省略すると、新しい一意の名前が自動的に生成されます。 |
|---|---|
| 戻り値: | 新しく作成されたライト リンク セット。vrLightService.lightLinkSetsChanged() 信号が送信されます。 |
| 戻り値の型: | vrdLightLinkSetNode |
vrLightService.duplicateLensFlareElements(light, elements)ライトのレンズ フレア要素を複製して、同じライトに追加します。
| パラメータ: |
|
|---|
vrLightService.duplicateLensFlareGhosts(ghostLine, ghosts)ゴースト ラインのレンズ フレア ゴーストを複製し、同じゴースト ラインに追加します。
| パラメータ: |
|
|---|
vrLightService.duplicateLights(nodes)ライト グラフ内の指定したすべてのライト ノードを複製します。複製されたノードは、元のノードと同じ親の下に追加されます。
| パラメータ: | nodes (List[vrdNode]): 複製するすべてのライト ノードのリスト。 |
|---|
vrLightService.findLight(name)ライト グラフ内で指定された名前を持つライト ノードを検索します。
| パラメータ: | name (string): 検索されたライト ノードの名前 |
|---|---|
| 戻り値: | ライト ノード。この名前のライト ノードが見つからない場合は、null になる可能性があります。 |
| 戻り値の型: | vrdNode |
vrLightService.findLights(name)指定した名前を持つすべてのライト ノードを検索します。
| パラメータ: | name (string): 検索されたライト ノードの名前。ライトは、ライト グラフ内で検索されます。 |
|---|---|
| 戻り値: | ライト ノードのリスト。この名前のライト ノードが見つからない場合は、空になる可能性があります。 |
| 戻り値の型: | List[vrdNode] |
vrLightService.getAllLights(sceneGraph)すべてのライト ノードを返します。
| パラメータ: | sceneGraph (bool): true の場合は、シーングラフからノードを収集します。false の場合は、ライト グラフを使用します。 |
|---|---|
| 戻り値: | すべてのライト ノード |
| 戻り値の型: | List[vrdNode] |
vrLightService.getHeadlight()ヘッド ライト ノードを返します。
| 戻り値: | ヘッド ライト ノード |
|---|---|
| 戻り値の型: | vrdBaseLightNode |
vrLightService.getLightLinksRoot()すべてのライト セットを含む、ライト セットのルート ノードを返します。
| 戻り値: | ライト セット ツリーのルート ノード |
|---|---|
| 戻り値の型: | vrdNode |
vrLightService.getLightRoot()すべてのライトとレンズ フレアを含む、ライトのルート ノードを返します。
| 戻り値: | ライト グラフのルート ノード |
|---|---|
| 戻り値の型: | vrdNode |
vrLightService.getLightsClipboard()| 戻り値: | クリップボードから取得したライト ノードのリスト。 |
|---|---|
| 戻り値の型: | List[vrdNode] |
vrLightService.getSelectedLensFlareElements()選択したレンズ フレア要素を取得します。
| 戻り値: | 選択したレンズ フレア要素 |
|---|---|
| 戻り値の型: | List[vrdLensFlareElement] |
vrLightService.getSelectedLensFlareGhosts()現在選択されているゴーストを取得します。
| 戻り値: | 現在選択されているゴースト。 |
|---|---|
| 戻り値の型: | List[vrdLensFlareGhost] |
vrLightService.getSelectedNodes()内部バッファから、現在選択されているすべてのライト ノードを返します。
| 戻り値: | 現在選択されているすべてのライト ノードのリスト |
|---|---|
| 戻り値の型: | List[vrdNode] |
vrLightService.hasCopiedGhosts()ゴースト要素がクリップボードで使用可能かどうかを確認します。
| 戻り値: | ゴースト要素がクリップボードで使用可能な場合は True |
|---|---|
| 戻り値の型: | bool |
vrLightService.hasCopiedLensFlareEffect()レンズ フレア効果がクリップボードで使用可能であることを確認します。
| 戻り値: | レンズ フレア効果がクリップボードで使用可能な場合は True |
|---|---|
| 戻り値の型: | bool |
vrLightService.hasCopiedLensFlareElements()レンズ フレア要素がクリップボードで使用可能かどうかを確認します。
| 戻り値: | レンズ フレア要素がクリップボードで使用可能な場合は True |
|---|---|
| 戻り値の型: | bool |
vrLightService.isHeadLight(light)指定したノードがヘッド ライト ノードであるかどうかを確認します。
| パラメータ: | light (vrdBaseLightNode) – |
|---|---|
| 戻り値: | 指定したノードがヘッド ライト ノードである場合は True |
| 戻り値の型: | bool |
vrLightService.isLightsClipboardEmpty()ライト ノードがクリップボードで使用可能かどうかを確認します。
| 戻り値: | クリップボードが空の場合は true |
|---|---|
| 戻り値の型: | bool |
vrLightService.loadLights(paths)OpenSG バイナリ ジオメトリまたは VRED プロジェクト バイナリ ファイルからライトをロードします
| パラメータ: | paths (List[string]): バイナリ ファイルの完全なファイル パス |
|---|---|
| 戻り値: | 新しく追加されたすべてのライト ノード |
| 戻り値の型: | List[vrdNode] |
vrLightService.pasteLensFlare(lights)コピー バッファから 1 つまたは複数のライトにレンズ フレアの効果を貼り付けます。
| パラメータ: | lights (List[vrdPointLightNode]): レンズ フレア効果のコピー先となるライト。 |
|---|
vrLightService.pasteLensFlareElements(light)クリップボードからライトにレンズ フレア要素を貼り付けます。
| パラメータ: | light (vrdPointLightNode): レンズ フレア要素のコピー先となるライト。 |
|---|
vrLightService.pasteLensFlareGhosts(ghostLine)コピー バッファ内のすべてのゴーストをゴースト ラインに貼り付けます。
| パラメータ: | ghostLine (vrdLensFlareGhostLine): ゴーストを貼り付けるゴースト ライン。 |
|---|
vrLightService.pasteLights(targetNodes)指定したすべてのライト ノードをクリップボードからグラフに貼り付けます。クリップボードの内容は変更されません。
| パラメータ: | targetNodes (List[vrdNode]): ノードを貼り付けるターゲット ノード。 |
|---|
vrLightService.removeLightLinkSets(nodes)ライト リンク セットを削除します。
| パラメータ: | nodes (List[vrdLightLinkSetNode]): 削除するすべてのライト リンク セットのリスト。vrLightService.lightLinkSetsChanged() 信号が送信されます。 |
|---|
vrLightService.removeLights(nodes)ライト グラフ内の指定したすべてのライト ノードを削除します。
| パラメータ: | nodes (List[vrdNode]): 削除するすべてのライト ノードのリスト |
|---|
vrLightService.saveLights(nodes, path)指定したノード内のすべてのライトを再帰的に収集し、OpenSG バイナリ ジオメトリ ファイルとして保存します。
| パラメータ: |
|
|---|---|
| 戻り値: | ファイルが正常に保存されている場合は True |
| 戻り値の型: | bool |
vrLightService.setSelectedLensFlareElements(elements)選択したすべてのレンズ フレア要素を設定します。
| パラメータ: | elements (List[vrdLensFlareElement]): 選択する必要があるすべてのレンズ フレア要素のリスト。 |
|---|
vrLightService.setSelectedLensFlareGhosts(ghosts)選択したゴーストを設定します。現在選択されているすべてのゴーストを、選択されていない状態にリセットします。vrLightService.lensFlareGhostSelectionChanged(ghosts) 信号が送信されます。
| パラメータ: | ghosts (List[vrdLensFlareGhost]): 選択されるゴーストのリスト。 |
|---|
vrLightService.setSelectedNodes(nodes)選択したすべてのライト ノードを設定します。現在選択されているすべてのノードが、選択されていない状態にリセットされます。ライト サービスのほぼすべてのコマンドが、選択したノードで機能します。vrLightService.nodeSelectionChanged(nodes) 信号が送信されます。
| パラメータ: | nodes (List[vrdNode]): 現在選択されているすべてのライト ノードのリスト。 |
|---|
vrLightService.validateLights()シーン グラフ内のすべてのライトがライト グラフ内のライトに相互に対応しているかどうかを検証します。有効な親を持たないライトは削除されます。vrLightService.lightsValidated() 信号が送信されます。
vrLightService.lensFlareElementSelectionChanged(elements)レンズ フレア要素の選択バッファが変更されている場合は、信号が送信されます。
| パラメータ: | elements (List[vrdLensFlareElement]): 現在選択されているすべてのレンズ フレア要素 |
|---|
vrLightService.lensFlareGhostSelectionChanged(ghosts)選択したゴーストのリストが変更されている場合は、信号が送信されます。
| パラメータ: | ghosts (List[vrdLensFlareGhost]): 選択されてるすべてのゴーストの新しいリスト |
|---|
vrLightService.lightsConverted(lightIds)ライトがさまざまなライト タイプに変換されるときに送信される信号。
| パラメータ: | lightIds (List[integer]): 変換されたライトのオブジェクト ID。 |
|---|
vrLightService.nodesAdded(nodes)ライト ノードが追加されている場合は、信号が送信されます。
| パラメータ: | nodes (List[vrdNode]): 新しく作成されたライト ノード |
|---|
vrLightService.nodesChanged(nodes)ライト ノードが変更されている場合は、信号が送信されます。
| パラメータ: | nodes (List[vrdNode]): 変更されたすべてのライト ノード |
|---|
vrLightService.nodeSelectionChanged(nodes)ライト ノードの選択バッファが変更されている場合は、信号が送信されます。
| パラメータ: | nodes (List[vrdNode]): 現在選択されているすべてのライト ノード |
|---|
vrLightService.nodesRemoved(nodes)ライト ノードが削除されている場合は、信号が送信されます。
| パラメータ: | nodes (List[vrdNode]): 削除されているすべてのライト ノード |
|---|