LabRPS: /* Introduction */

2024-10-28T16:07:27Z

Introduction

← Older revision		Revision as of 09:07, 28 October 2024
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	[[Viewprovider\|Viewproviders]] are classes that define the way objects will look like in the [[tree_view\|tree view]], and how they will interact with certain graphical actions such as ~~[[Selection_methods\|~~selection]].		[[Viewprovider\|Viewproviders]] are classes that define the way objects will look like in the [[tree_view\|tree view]], and how they will interact with certain graphical actions such as selection.

	They complement the [[scripted_objects\|scripted objects]]. While the base class of the scripted object defines its {{Emphasis\|data}} [[property\|properties]], the viewprovider defines it {{Emphasis\|view}} [[property\|properties]]. These view properties are not essential information of the object, as they only indicate superficial information like line width, height, etc. In a terminal only session, the viewprovider is not loaded because there will be no interface to manipulate those visible properties.		They complement the [[scripted_objects\|scripted objects]]. While the base class of the scripted object defines its {{Emphasis\|data}} [[property\|properties]], the viewprovider defines it {{Emphasis\|view}} [[property\|properties]]. These view properties are not essential information of the object, as they only indicate superficial information like line width, height, etc. In a terminal only session, the viewprovider is not loaded because there will be no interface to manipulate those visible properties.

LabRPS: Created page with "== Introduction == Viewproviders are classes that define the way objects will look like in the tree view, and how they will interact with certain graphical actions such as selection. They complement the scripted objects. While the base class of the scripted object defines its {{Emphasis|data}} properties, the viewprovider defines it {{Emphasis|view}} properties. These v..."

2024-10-28T15:55:49Z

Created page with "== Introduction == Viewproviders are classes that define the way objects will look like in the tree view, and how they will interact with certain graphical actions such as selection. They complement the scripted objects. While the base class of the scripted object defines its {{Emphasis|data}} properties, the viewprovider defines it {{Emphasis|view}} properties. These v..."

New page

== Introduction ==

[[Viewprovider|Viewproviders]] are classes that define the way objects will look like in the [[tree_view|tree view]], and how they will interact with certain graphical actions such as [[Selection_methods|selection]].

They complement the [[scripted_objects|scripted objects]]. While the base class of the scripted object defines its {{Emphasis|data}} [[property|properties]], the viewprovider defines it {{Emphasis|view}} [[property|properties]]. These view properties are not essential information of the object, as they only indicate superficial information like line width, height, etc. In a terminal only session, the viewprovider is not loaded because there will be no interface to manipulate those visible properties.

Like with data properties, view properties are accessible from the [[property_editor|property editor]].

== Python view providers ==

The viewproviders classes usually include {{incode|ViewProvider}} in their name. They are assigned on the {{incode|ViewObject}} attribute of the base object.

In this example, we define two properties for the viewprovider, only if the properties don't already exist, and assign their default values. We also define the {{incode|onChanged}} method that runs every time a property changes. We need to test the property by name, and then we will call one of two methods that will do the actual work of updating the pattern or setting its size.
{{Code|code=
# views/view_custom.py
class ViewProviderCustom:
"""Viewprovider of the custom object."""

def __init__(self, vobj):
self.Object = vobj.Object

self._set_properties(vobj)
vobj.Proxy = self

def _set_properties(self, vobj):
if not hasattr(vobj, "Pattern"):
vobj.addProperty("App::PropertyEnumeration",
"Pattern",
"Custom",
"Defines a hatch pattern for this object.")
vobj.Pattern = ["None", "diagonals", "cross", "brick"]

if not hasattr(vobj, "PatternSize"):
vobj.addProperty("App::PropertyFloat",
"PatternSize",
"Custom",
"Defines the size of the hatch pattern.")
vobj.PatternSize = 1

def onChanged(self, vobj, prop):
if prop in "Pattern":
self._set_pattern(vobj.Pattern)
if prop in "PatternSize":
self._set_size(vobj.PatternSize)

def _set_pattern(self, pattern):
...

def _set_size(self, size):
...
}}

The normal workflow is to first add the object proxy class, for example, {{incode|CustomObject}}, and then the viewprovider, for example, {{incode|ViewProviderCustom}}. The viewprovider can only be assigned when we have verified that the graphical interface is available, as otherwise the {{incode|ViewObject}} attribute doesn't exist, and it will be an error to use this element as input for our class.
{{Code|code=
import LabRPS as App
import objects.custom as custom
import views.view_custom as view_custom

doc = App.newDocument()
obj = doc.addObject("Part::FeaturePython", "Custom")

custom.CustomObject(obj)

if App.GuiUp:
view_custom.ViewProviderCustom(obj.ViewObject)
}}

== Custom icons ==

By implementing the {{incode|getIcon}} method, you can specify the icon that will be shown in the [[tree_view|tree view]] in the upper part of the [[combo_view|combo view]].

The return value can be the full path to an icon.
{{Code|code=
import os
some_path = "/home/user/.LabRPS/custom_icons"

class ViewProviderCustom:
...

def getIcon(self):
return os.path.join(some_path, "my_icon.svg")
}}

The relative path to an icon inside a compiled resource file.
{{Code|code=
import MyModule_rc.py

class ViewProviderCustom:
...

def getIcon(self):
return ":/icons/my_icon.svg"
}}

A raw [https://en.wikipedia.org/wiki/X_PixMap XPM icon], which is essentially ASCII art.
{{Code|code=
import MyModule_rc.py

class ViewProviderCustom:
...

def getIcon(self):
return """
/* XPM */
static char *Some_icon_xpm[] = {
/* columns rows colors chars-per-pixel */
"16 16 3 1 ",
" c None",
". c #D71414",
"+ c #AA1919",
/* pixels */
" ",
" + + ",
" +.+ +.+ ",
" +.+ +.+ ",
" + + ",
" ++++ ",
" +....+ ",
" +...++ ",
" +..+++ ",
" +.++.+ ",
" ++++ ",
" + + ",
" +.+ +.+ ",
" +.+ +.+ ",
" + + ",
" "
};
"""
}}

See various examples in [[Custom_icon_in_tree_view|Custom icon in tree view]].

{{Powerdocnavi}}
[[Category:Developer Documentation]]
[[Category:Python Code]]
{{clear}}

Viewprovider - Revision history

LabRPS: /* Introduction */