rfm2.vp.debug Namespace Reference

Classes
class	XMLHighlighter
class	CodeView
class	ExtendedComboBox
class	HelpButton

Functions
def	build_tooltip (elmt, pname, ignore=['name'])
def	frame_all (margin=5)
def	on_key_pressed (key)
def	on_double_click (name)
def	set_styles (graph)
def	show (fragment=None, node=None)
def	graph_fragment (menu, code_widget, frag_name=None)
def	graph_node_fragment (field, code_widget)
def	get_fragment (frag)
def	get_node_fragment (nodename)
def	list_fragments ()
def	match (string)
def	builtin_shader_params (idx)
def	auto_layout_graph (graph, nodes=None, margin=50)

Variables
	long = int
string	HELP
string	STYLE_TOOLTIP

Detailed Description

Private VP2 debugging UI.
Requires Qt.py (https://github.com/mottosso/Qt.py) and
Nodz (https://github.com/LeGoffLoic/Nodz) to work.

Function Documentation

auto_layout_graph()

def rfm2.vp.debug.auto_layout_graph	(		graph,
			nodes = None,
			margin = 50
	)

Auto set nodes positions in the graph according to their connections.

Here is the call graph for this function:

Here is the caller graph for this function:

build_tooltip()

def rfm2.vp.debug.build_tooltip	(		elmt,
			pname,
			ignore = ['name']
	)

build a tooltip string by harvesting an xml element's attributes.

Here is the call graph for this function:

builtin_shader_params()

def rfm2.vp.debug.builtin_shader_params

(

idx

)

debug

frame_all()

def rfm2.vp.debug.frame_all

(

margin = 5

)

Frame all graph nodes and add some padding for free roaming

Here is the caller graph for this function:

get_fragment()

def rfm2.vp.debug.get_fragment

(

frag

)

Return the xml fragment of a registered fragment.

Here is the caller graph for this function:

get_node_fragment()

def rfm2.vp.debug.get_node_fragment

(

nodename

)

Return the xml fragment for a scene node.

Here is the call graph for this function:

Here is the caller graph for this function:

graph_fragment()

def rfm2.vp.debug.graph_fragment	(		menu,
			code_widget,
			frag_name = None
	)

graph a registered xml fragment

Here is the call graph for this function:

Here is the caller graph for this function:

graph_node_fragment()

def rfm2.vp.debug.graph_node_fragment	(		field,
			code_widget
	)

graph a scene node fragment

Here is the call graph for this function:

Here is the caller graph for this function:

list_fragments()

def rfm2.vp.debug.list_fragments

(

)

list all registered fragments

Here is the caller graph for this function:

match()

def rfm2.vp.debug.match

(

string

)

debug

Here is the call graph for this function:

Here is the caller graph for this function:

on_double_click()

def rfm2.vp.debug.on_double_click

(

name

)

double-click callback: dive into a node

on_key_pressed()

def rfm2.vp.debug.on_key_pressed

(

key

)

Implement key shortcuts for our graph

Here is the call graph for this function:

set_styles()

def rfm2.vp.debug.set_styles

(

graph

)

insert custom styles

Here is the caller graph for this function:

show()

def rfm2.vp.debug.show	(		fragment = None,
			node = None
	)

Build and open the VP2 xml fragment viewer

Here is the call graph for this function:

Variable Documentation

HELP

string rfm2.vp.debug.HELP

Initial value:

=  '''<h2>Explorer help</h2>
<h4>Fragment field</h4>
<p>Select an existing fragment or start typing a fragment name.</p>
<h4>Scene Object Name field</h4>
<p>Enter the name of an existing maya material</p>
<h3>Fragment Graph Tab</h3>
<p>Graph the fragment selected in the fields above.</p>
<h4>Node color-coding</h4>
<ul><li>grey node: shading fragment.</li>
<li>blue node: shading graph</li></ul>
<h4>Graph navigation</h4>
<ul>
    <li>Double-click a node to graph it (dive-in)</li>
    <li>Press escape to get back to the previous graph level (come-back-up)</li>
    <li>F: frame selected node(s)</li>
    <li>A: frame all nodes</li>
    <li>L: auto-layout nodes</li>
</ul>
<h3>Fragment Code Tab</h3>
<p>Display the xml code of the graphed fragment.</p>
'''

long

rfm2.vp.debug.long = int

STYLE_TOOLTIP

string rfm2.vp.debug.STYLE_TOOLTIP

Initial value:

=  '''QToolTip {
    color: #ddd;
    background-color: #555;
    border-style: solid;
    border-width: 1px;
    border-color: #888;
    padding: 4px;
}'''