Proxy class for Gui.ViewProviderDocumentObject Trajectory.ViewObject. More...

Public Member Functions
def	__init__ (self, vp)
	Initialization method for ViewProviderTrajectoryProxy. More...

def	attach (self, vp)
	Method called by FreeCAD after initialization to attach Coin3D constructs. More...

def	updateData (self, fp, prop)
	Method called after `DocumentObjectGroupPython` Trajectory was changed. More...

def	onChanged (self, vp, prop)
	Method called after Trajectory.ViewObject was changed. More...

def	claimChildren (self)
	Method called by FreeCAD to retrieve assigned children. More...

def	canDropObject (self, obj)
	Method called by FreeCAD to ask if an object `obj` can be dropped into a Group. More...

def	getIcon (self)
	Method called by FreeCAD to supply an icon for the Tree View. More...

def	__getstate__ (self)
	Necessary method to avoid errors when trying to save unserializable objects. More...

def	__setstate__ (self, state)
	Necessary method to avoid errors when trying to restore unserializable objects. More...

def	setProperties (self, vp)
	Method to hide unused properties. More...

def	doubleClicked (self, vp)
	Method called by FreeCAD when Trajectory is double-clicked in the Tree View. More...

def	setupContextMenu (self, vp, menu)
	Method called by the FreeCAD to customize a context menu for a Trajectory. More...

def	makeLabels (self)
	Method which makes Coin3D labels to be displayed in the FreeCAD View. More...

def	makeFrame (self, frame_labels)
	Method which makes a Coin3D frame to show a current pose in a trajectory. More...

def	makeRotationAxis (self, axis_label)
	Method which makes a Coin3D rotation axis to show in the FreeCAD View. More...

Public Attributes
	tf_object2world
	A SoTransform transformation from object to world frame. More...

	font
	A SoFontStyle font for axes labels. More...

	rot_axis
	A SoSwitch with a rotation axis in form of an arrow. More...

	frame
	A SoSeparator with a coordinate frame made from 3 RGB arrows. More...

	visualisations
	A SoSwitch with all visualisations (frame & rotation axis). More...

	label_texts
	A list of `SoText2`s labels denoting all axes and an origin. More...

	label_translations
	A list of `SoTranslation`s moving labels. More...

	labels
	A list of `SoSwitch`es containing colored translated labels. More...

	axis_label_color
	A SoPackedColor coloring a rotational axis(RA) label. More...

	frame_shaft
	A SoLineSet shaft for frame axes. More...

	frame_arrowhead_translation
	A SoTranslation moving frame arrowheads. More...

	frame_arrowhead_cone
	A SoCone arrowhead cone for frame axes. More...

	frame_arrowhead
	A SoSwitch translated cone for frame axes. More...

	frame_color_x
	A SoPackedColor red color for an X axis. More...

	frame_color_y
	A SoPackedColor green color for an Y axis. More...

	frame_color_z
	A SoPackedColor blue color for an Z axis. More...

	frame_drawstyle
	A SoDrawStyle controlling frame axes shaft line width. More...

	rot_axis_shaft
	A SoLineSet shaft for a rotation axis. More...

	rot_axis_arrowhead_translation
	A SoTranslation moving a RA arrowhead. More...

	rot_axis_arrowhead_cone
	A SoCone arrowhead cone for a rotation axis. More...

	rot_axis_arrowhead
	A SoSwitch translated cone for a rotation axis. More...

	tf_y2axis
	A SoTransform transformation from Y axis to a rotation axis. More...

	rot_axis_color
	A SoPackedColor coloring a rotational axis. More...

	rot_axis_drawstyle
	A SoDrawStyle controlling RA shaft line width. More...

Static Public Attributes
	panel = None
	A TrajectoryPanel if one is active or None. More...

	fp = None
	A Trajectory object. More...

Detailed Description

Proxy class for Gui.ViewProviderDocumentObject Trajectory.ViewObject.

A ViewProviderTrajectoryProxy instance provides a Trajectory's icon, double-click response and context menu with a Select Time option.

To connect this Proxy object to a Gui.ViewProviderDocumentObject Trajectory.ViewObject do:

a = FreeCAD.ActiveDocument.addObject("App::DocumentObjectGroupPython",
                                     "Trajectory")
ViewProviderTrajectoryProxy(a.ViewObject)

Definition at line 824 of file Trajectory.py.

Constructor & Destructor Documentation

◆ init()

def Trajectory.ViewProviderTrajectoryProxy.__init__	(	self,
		vp
	)

Initialization method for ViewProviderTrajectoryProxy.

A class instance is created and made a Proxy for a generic Gui.ViewProviderDocumentObject Trajectory.ViewObject. During initialization number of properties are specified and preset.

Parameters

vp	A barebone `Gui.ViewProviderDocumentObject` Trajectory.ViewObject.

Definition at line 918 of file Trajectory.py.

     def __init__(self, vp):
         self.setProperties(vp)
         vp.Proxy = self
 

Member Function Documentation

◆ getstate()

def Trajectory.ViewProviderTrajectoryProxy.__getstate__ ( self )

Necessary method to avoid errors when trying to save unserializable objects.

This method is used by JSON to serialize unserializable objects during autosave. Without this an Error would rise when JSON would try to do that itself.

We need this for unserializable fp attribute, but we don't serialize it, because it's enough to reset it when object is restored.

Returns: None, because we don't serialize anything.

Definition at line 1250 of file Trajectory.py.

     def __getstate__(self):
         return None
 

◆ setstate()

def Trajectory.ViewProviderTrajectoryProxy.__setstate__	(	self,
		state
	)

Necessary method to avoid errors when trying to restore unserializable objects.

This method is used during a document restoration. We need this for unserializable fp attribute, but we do not restore it, because it's enough to reset it.

Definition at line 1260 of file Trajectory.py.

     def __setstate__(self, state):
         pass
 

◆ attach()

def Trajectory.ViewProviderTrajectoryProxy.attach	(	self,
		vp
	)

Method called by FreeCAD after initialization to attach Coin3D constructs.

A coordinate frame made of RGB arrows corresponding to X, Y and Z axes. This frame shows current pose in a trajectory. This method adds Trajectory as the fp attribute.

Parameters

vp	A Trajectory.ViewObject after initialization.

Definition at line 932 of file Trajectory.py.

     def attach(self, vp):
         # prepare transformation to keep pose corresponding to placement
         self.tf_object2world = coin.SoTransform()
 
         labels = self.makeLabels()
         self.font = coin.SoFontStyle()
 
         axis = self.makeRotationAxis(labels[3])
         axis.insertChild(self.tf_object2world, 0)
         axis.insertChild(self.font, 1)
         self.rot_axis = coin.SoSwitch()
         self.rot_axis.addChild(axis)
 
         frame = self.makeFrame(labels[:3])
         frame.insertChild(self.tf_object2world, 0)
         frame.insertChild(self.font, 1)
         self.frame = coin.SoSwitch()
         self.frame.addChild(frame)
 
         self.visualisations = coin.SoSwitch()
         self.visualisations.addChild(self.rot_axis)
         self.visualisations.addChild(self.frame)
         self.visualisations.whichChild.setValue(coin.SO_SWITCH_ALL)
         vp.RootNode.addChild(self.visualisations)
 
         vp.Object.Proxy.setProperties(vp.Object)
         self.setProperties(vp)
         self.fp = vp.Object
 

◆ canDropObject()

def Trajectory.ViewProviderTrajectoryProxy.canDropObject	(	self,
		obj
	)

Method called by FreeCAD to ask if an object obj can be dropped into a Group.

Only FreeCAD objects of a Trajectory type are allowed to drop inside a Trajectory group.

Parameters

obj	A FreeCAD object hovering above a Trajectory item in the Tree View.

Definition at line 1220 of file Trajectory.py.

     def canDropObject(self, obj):
         if hasattr(obj, "Proxy") and \
            isinstance(obj.Proxy, self.fp.Proxy.__class__):
             return True
         return False
 

◆ claimChildren()

def Trajectory.ViewProviderTrajectoryProxy.claimChildren ( self )

Method called by FreeCAD to retrieve assigned children.

When a property of a Trajectory is touched the Trajectory and the FreeCAD ActiveDocument are notified. The FreeCAD ActiveDocument then emits a signal to inform all its observers e.g. the FreeCADGui ActiveDocument. The FreeCADGui document then emits a new signal to inform e.g. the tree view. The tree view then invokes claimChildren().

Definition at line 1206 of file Trajectory.py.

     def claimChildren(self):
         if hasattr(self, "fp") and self.fp:
             return self.fp.Group
         return []
 

◆ doubleClicked()

def Trajectory.ViewProviderTrajectoryProxy.doubleClicked	(	self,
		vp
	)

Method called by FreeCAD when Trajectory is double-clicked in the Tree View.

If no dialog is opened in the Task View, a new TrajectoryPanel is opened. If another TrajectoryPanel is opened, it is closed and all its QDialogs are added to a new TrajectoryPanel. If a TrajectoryPanel is already opened, the Model tab on the Combo View is swapped for the Tasks tab so that the panel becomes visible. If another dialog is opened a warning is shown.

Parameters

vp	A `Gui.ViewProviderDocumentObject` Trajectory.ViewObject.

Definition at line 1287 of file Trajectory.py.

     def doubleClicked(self, vp):
         # Switch to the Task View if a Trajectory panel is already opened
         if self.panel:
             FreeCADGui.Control.showTaskView()
 
         # Try to open new Trajectory panel
         else:
             # Check there is a valid trajectory
             if not vp.Object.ValidTrajectory:
                 QMessageBox.warning(
                     None,
                     'Error while opening trajectory panel',
                     "Valid trajectory is necessary to open "
                     + "a trajectory panel.")
                 return True
 
             # Load the QDialog from a file and name it after this object
             new_form = [FreeCADGui.PySideUic.loadUi(path.join(PATH_TO_UI,
                                                     "AnimationTrajectory.ui"))]
             new_form[0].setWindowTitle(vp.Object.Label)
 
             # Create a control panel and try to show it
             self.panel = TrajectoryPanel([vp.Object], new_form)
             try:
                 FreeCADGui.Control.showDialog(self.panel)
             except RuntimeError as e:
                 # Reset the panel
                 self.panel = None
 
                 # Find all Trajectory feature python objects with
                 # a reference to a Trajectory panel
                 trajectories = []
                 for obj in FreeCAD.ActiveDocument.Objects:
                     if hasattr(obj, "Proxy") and \
                             obj.Proxy.__class__.__name__ == "TrajectoryProxy":
                         if obj.ViewObject.Proxy.panel is not None:
                             trajectories.append(obj)
 
                 if len(trajectories) > 0:
                     # Close opened Trajecotry panel
                     trajectories[0].ViewObject.Proxy.panel.reject()
 
                     # Load the QDialog form for each Trajectory which
                     # had a reference to the panel
                     forms = []
                     for trajectory in trajectories:
                         form = FreeCADGui.PySideUic.loadUi(
                                 path.join(PATH_TO_UI,
                                           "AnimationTrajectory.ui"))
                         form.setWindowTitle(trajectory.Label)
                         forms.append(form)
 
                     # Load one more QDialog for this Trajectory
                     forms.append(new_form[0])
 
                     # Add this Trajectory to the list of trajectories
                     trajectories.append(vp.Object)
 
                     # Add a reference to the new panel to view providers
                     # of all trajectories
                     self.panel = TrajectoryPanel(trajectories, forms)
                     for trajectory in trajectories:
                         trajectory.ViewObject.Proxy.panel = self.panel
                     FreeCADGui.Control.showDialog(self.panel)
                     return True
 
                 # Diffeerent Task panel is opened, inform the user
                 else:
                     QMessageBox.warning(
                         None,
                         'Error while opening trajectory panel',
                         "A different panel is already active.\n"
                         + "Close it before opening this one.")
                 FreeCADGui.Control.showTaskView()
         return True
 

◆ getIcon()

def Trajectory.ViewProviderTrajectoryProxy.getIcon ( self )

Method called by FreeCAD to supply an icon for the Tree View.

A full path to an icon is supplied for the FreeCADGui.

Returns: A str path to an icon.

Definition at line 1234 of file Trajectory.py.

     def getIcon(self):
         return path.join(PATH_TO_ICONS, "Trajectory.png")
 

◆ makeFrame()

def Trajectory.ViewProviderTrajectoryProxy.makeFrame	(	self,
		frame_labels
	)

Method which makes a Coin3D frame to show a current pose in a trajectory.

A frame is made from 3 red, green and blue arrows representing X, Y and Z. Arrows are each constructed from a shaft and an arrowhead. Their dimensions and other attributes are unassigned as they are extracted from appropriate Trajectory properties.

Returns: A SoSeparator with the frame shown in the FreeCAD View.

Definition at line 1432 of file Trajectory.py.

     def makeFrame(self, frame_labels):
         # make a generic shaft from 0 in Y direction
         shaft_vertices = coin.SoVertexProperty()
         shaft_vertices.vertex.setNum(2)
         shaft_vertices.vertex.set1Value(0, 0, 0, 0)
         self.frame_shaft = coin.SoLineSet()
         self.frame_shaft.vertexProperty.setValue(shaft_vertices)
         self.frame_shaft.numVertices.setNum(1)
         self.frame_shaft.numVertices.setValue(2)
 
         # make a generic conic arrowhead oriented in Y axis direction and
         # move it at the end of the shaft
         self.frame_arrowhead_translation = coin.SoTranslation()
         self.frame_arrowhead_cone = coin.SoCone()
         self.frame_arrowhead = coin.SoSwitch()
         self.frame_arrowhead.addChild(self.frame_arrowhead_translation)
         self.frame_arrowhead.addChild(self.frame_arrowhead_cone)
 
         # make rotations to rotate prepared shaft and arrowhead for Y axis
         # direction also to X and Z
         rot_y2x = coin.SoRotation()
         rot_y2x.rotation.setValue(coin.SbRotation(coin.SbVec3f(0, 1, 0),
                                                   coin.SbVec3f(1, 0, 0)))
         rot_y2z = coin.SoRotation()
         rot_y2z.rotation.setValue(coin.SbRotation(coin.SbVec3f(0, 1, 0),
                                                   coin.SbVec3f(0, 0, 1)))
 
         # prepare colors for X,Y,Z which will correspond to R,G,B as customary
         self.frame_color_x = coin.SoPackedColor()
         self.frame_color_y = coin.SoPackedColor()
         self.frame_color_z = coin.SoPackedColor()
 
         # make complete colored and rotated arrows
         x_arrow = coin.SoSeparator()
         x_arrow.addChild(rot_y2x)
         x_arrow.addChild(self.frame_color_x)
         x_arrow.addChild(self.frame_shaft)
         x_arrow.addChild(self.frame_arrowhead)
         x_arrow.addChild(frame_labels[0])
         y_arrow = coin.SoSeparator()
         y_arrow.addChild(self.frame_color_y)
         y_arrow.addChild(self.frame_shaft)
         y_arrow.addChild(self.frame_arrowhead)
         y_arrow.addChild(frame_labels[1])
         z_arrow = coin.SoSeparator()
         z_arrow.addChild(rot_y2z)
         z_arrow.addChild(self.frame_color_z)
         z_arrow.addChild(self.frame_shaft)
         z_arrow.addChild(self.frame_arrowhead)
         z_arrow.addChild(frame_labels[2])
 
         # prepare draw style to control shaft width
         self.frame_drawstyle = coin.SoDrawStyle()
 
         # make complete frame and it to shaded display mode
         separated_frame = coin.SoSeparator()
         separated_frame.addChild(self.frame_drawstyle)
         separated_frame.addChild(x_arrow)
         separated_frame.addChild(y_arrow)
         separated_frame.addChild(z_arrow)
 
         return separated_frame
 

◆ makeLabels()

def Trajectory.ViewProviderTrajectoryProxy.makeLabels ( self )

Method which makes Coin3D labels to be displayed in the FreeCAD View.

Frame labels for axes X, Y and Z and a label for rotation axis are made. The labels have the same color as the axes.

Returns: A SoSwitch with colored text label to be shown in the FreeCAD View.

Definition at line 1389 of file Trajectory.py.

     def makeLabels(self):
         label_strings = ["X", "Y", "Z", "O"]
         colors = [0xFF0000FF, 0x00FF00FF, 0x0000FFFF]
         self.label_texts = []
         self.label_translations = []
         # frame translation
         self.label_translations.append(coin.SoTranslation())
         # axis translation
         self.label_translations.append(coin.SoTranslation())
         self.labels = []
         for i in range(4):
             label_group = coin.SoSeparator()
             if i < 3:
                 label_group.addChild(self.label_translations[0])
                 frame_axis_color = coin.SoPackedColor()
                 frame_axis_color.orderedRGBA.setValue(colors[i])
                 label_group.addChild(frame_axis_color)
             else:
                 label_group.addChild(self.label_translations[1])
                 self.axis_label_color = coin.SoPackedColor()
                 label_group.addChild(self.axis_label_color)
             self.label_texts.append(coin.SoText2())
             self.label_texts[i].string.setValues(
                 0, 3, ["", label_strings[i], ""])
             self.label_texts[i].justification.setValue(
                 self.label_texts[i].CENTER)
             self.label_texts[i].spacing.setValue(0.45)
             label_group.addChild(self.label_texts[i])
             self.labels.append(coin.SoSwitch())
             self.labels[i].addChild(label_group)
         return self.labels
 

◆ makeRotationAxis()

def Trajectory.ViewProviderTrajectoryProxy.makeRotationAxis	(	self,
		axis_label
	)

Method which makes a Coin3D rotation axis to show in the FreeCAD View.

A rotation axis is made from a shaft and an arrowhead. Its dimensions and other attributes are unassigned as they are extracted from appropriate Trajectory properties.

Returns: A SoSeparator with the rotation axis to be shown in the FreeCAD View.

Definition at line 1505 of file Trajectory.py.

     def makeRotationAxis(self, axis_label):
         # make a generic shaft from 0 in Y direction
         shaft_vertices = coin.SoVertexProperty()
         shaft_vertices.vertex.setNum(2)
         shaft_vertices.vertex.set1Value(0, 0, 0, 0)
         self.rot_axis_shaft = coin.SoLineSet()
         self.rot_axis_shaft.vertexProperty.setValue(shaft_vertices)
         self.rot_axis_shaft.numVertices.setNum(1)
         self.rot_axis_shaft.numVertices.setValue(2)
 
         # make a generic conic arrowhead oriented in Y axis direction and
         # move it at the end of the shaft
         self.rot_axis_arrowhead_translation = coin.SoTranslation()
         self.rot_axis_arrowhead_cone = coin.SoCone()
         self.rot_axis_arrowhead = coin.SoSwitch()
         self.rot_axis_arrowhead.addChild(self.rot_axis_arrowhead_translation)
         self.rot_axis_arrowhead.addChild(self.rot_axis_arrowhead_cone)
 
         # make rotations to rotate prepared shaft and arrowhead for Y axis
         # direction also to X and Z
         self.tf_y2axis = coin.SoTransform()
 
         # prepare colors for X,Y,Z which will correspond to R,G,B as customary
         self.rot_axis_color = coin.SoPackedColor()
 
         # prepare draw style to control shaft width
         self.rot_axis_drawstyle = coin.SoDrawStyle()
 
         # make complete frame and it to shaded display mode
         separated_axis = coin.SoSeparator()
         separated_axis.addChild(self.tf_y2axis)
         separated_axis.addChild(self.rot_axis_drawstyle)
         separated_axis.addChild(self.rot_axis_color)
         separated_axis.addChild(self.rot_axis_shaft)
         separated_axis.addChild(self.rot_axis_arrowhead)
         separated_axis.addChild(axis_label)
 
         return separated_axis
 
 

◆ onChanged()

def Trajectory.ViewProviderTrajectoryProxy.onChanged	(	self,
		vp,
		prop
	)

Method called after Trajectory.ViewObject was changed.

If visibility changed, an appropriate Coin3D construct hides the frame showing current pose.

Parameters

vp	A Trajectory.ViewObject.
prop	A str name of a changed property.

Definition at line 1190 of file Trajectory.py.

     def onChanged(self, vp, prop):
         if prop == "Visibility":
             if vp.Visibility:
                 self.visualisations.whichChild.setValue(coin.SO_SWITCH_ALL)
             else:
                 self.visualisations.whichChild.setValue(coin.SO_SWITCH_NONE)
 

◆ setProperties()

def Trajectory.ViewProviderTrajectoryProxy.setProperties	(	self,
		vp
	)

Method to hide unused properties.

Property Display Mode is set to be invisible as they are unused.

Parameters

vp	A `Gui.ViewProviderDocumentObject` Trajectory.ViewObject.

Definition at line 1271 of file Trajectory.py.

     def setProperties(self, vp):
         # hide unnecessary view properties
         vp.setEditorMode("DisplayMode", 2)
 

◆ setupContextMenu()

def Trajectory.ViewProviderTrajectoryProxy.setupContextMenu	(	self,
		vp,
		menu
	)

Method called by the FreeCAD to customize a context menu for a Trajectory.

The Transform and Set colors... items are removed from the context menu shown upon right click on DocumentObjectGroupPython Trajectory in the Tree View. The option to Select Time is added instead.

Parameters

vp	A right-clicked `Gui.ViewProviderDocumentObject` Trajectory.ViewObject.
menu	A Qt's QMenu to be edited.

Definition at line 1374 of file Trajectory.py.

     def setupContextMenu(self, vp, menu):
         menu.clear()
         action = menu.addAction("Select Time")
         action.triggered.connect(lambda f=self.doubleClicked,
                                  arg=vp: f(arg))
 

◆ updateData()

def Trajectory.ViewProviderTrajectoryProxy.updateData	(	self,
		fp,
		prop
	)

Method called after DocumentObjectGroupPython Trajectory was changed.

This method is used to update Coin3D constructs, if associated properties changed e.g. if the FrameArrowheadRadius changes, all Coin3D cones representing frame arrowheads will change their radius accordingly.

Parameters

fp	A `DocumentObjectGroupPython` Trajectory object.
prop	A str name of a changed property.

Definition at line 972 of file Trajectory.py.

     def updateData(self, fp, prop):
         # Placement changes
         if prop == "Placement" and hasattr(fp, "Placement"):
             trans = fp.Placement.Base
             rot = fp.Placement.Rotation
             self.tf_object2world.translation.setValue((trans.x, trans.y,
                                                        trans.z))
             self.tf_object2world.rotation.setValue(rot.Q)
             if len(fp.Proxy.pose["rot_point"]) == 3 and \
                     len(fp.Proxy.pose["rot_axis"]) == 3:
                 self.tf_y2axis.rotation.setValue(
                     coin.SbRotation(coin.SbVec3f(0, 1, 0),
                                     coin.SbVec3f(fp.Proxy.pose["rot_axis"][0],
                                                  fp.Proxy.pose["rot_axis"][1],
                                                  fp.Proxy.pose["rot_axis"][2])
                                     ))
                 self.tf_y2axis.translation.setValue(
                         (fp.Proxy.pose["rot_point"][0],
                          fp.Proxy.pose["rot_point"][1],
                          fp.Proxy.pose["rot_point"][2]))
 
         # Frame changes
         elif prop == "ShowFrame" and hasattr(fp, "ShowFrame"):
             if fp.ShowFrame:
                 self.frame.whichChild.setValue(coin.SO_SWITCH_ALL)
             else:
                 self.frame.whichChild.setValue(coin.SO_SWITCH_NONE)
 
         elif prop == "FrameTransparency" and hasattr(fp, "FrameTransparency"):
             self.frame_color_x.orderedRGBA.\
                 setValue(0xff0000ff - (0xff*fp.FrameTransparency)//100)
             self.frame_color_y.orderedRGBA.\
                 setValue(0x00ff00ff - (0xff*fp.FrameTransparency)//100)
             self.frame_color_z.orderedRGBA.\
                 setValue(0x0000ffff - (0xff*fp.FrameTransparency)//100)
 
         elif prop == "ShaftLength" and hasattr(fp, "ShaftLength"):
             self.frame_shaft.vertexProperty.getValue().vertex.\
                 set1Value(1, 0, fp.ShaftLength, 0)
             if hasattr(fp, "FrameArrowheadLength"):
                 self.frame_arrowhead_translation.translation.setValue(
                     0, fp.ShaftLength + fp.FrameArrowheadLength/2, 0)
             if not fp.ShowFrameArrowheads and hasattr(fp, "DistanceToAxis"):
                 self.label_translations[0].translation.setValue(
                     0, fp.ShaftLength + fp.DistanceToAxis, 0)
 
         elif prop == "FrameArrowheadLength" and \
                 hasattr(fp, "FrameArrowheadLength"):
             self.frame_arrowhead_cone.height.setValue(fp.FrameArrowheadLength)
             if hasattr(fp, "ShaftLength"):
                 self.frame_arrowhead_translation.translation.setValue(
                     0, fp.ShaftLength + fp.FrameArrowheadLength/2, 0)
             if fp.ShowFrameArrowheads and hasattr(fp, "DistanceToAxis"):
                 self.label_translations[0].translation.setValue(
                     0, fp.FrameArrowheadLength/2 + fp.DistanceToAxis, 0)
 
         elif prop == "ShaftWidth" and hasattr(fp, "ShaftWidth"):
             self.frame_drawstyle.lineWidth.setValue(fp.ShaftWidth)
 
         elif prop == "FrameArrowheadRadius" and \
                 hasattr(fp, "FrameArrowheadRadius"):
             self.frame_arrowhead_cone.bottomRadius.setValue(
                 fp.FrameArrowheadRadius)
 
         elif prop == "ShowFrameArrowheads" and \
                 hasattr(fp, "ShowFrameArrowheads"):
             if fp.ShowFrameArrowheads:
                 self.frame_arrowhead.whichChild.setValue(coin.SO_SWITCH_ALL)
                 if hasattr(fp, "FrameArrowheadLength") and \
                         hasattr(fp, "DistanceToAxis"):
                     self.label_translations[0].translation.setValue(
                         0, fp.FrameArrowheadLength/2 + fp.DistanceToAxis, 0)
             else:
                 self.frame_arrowhead.whichChild.setValue(coin.SO_SWITCH_NONE)
                 if hasattr(fp, "ShaftLength") and \
                         hasattr(fp, "DistanceToAxis"):
                     self.label_translations[0].translation.setValue(
                         0, fp.ShaftLength + fp.DistanceToAxis, 0)
 
         elif prop == "ShowFrameLabels" and hasattr(fp, "ShowFrameLabels"):
             for label in self.labels[:3]:
                 if fp.ShowFrameLabels:
                     label.whichChild.setValue(coin.SO_SWITCH_ALL)
                 else:
                     label.whichChild.setValue(coin.SO_SWITCH_NONE)
 
         # Axis changes
         elif prop == "ShowRotationAxis" and hasattr(fp, "ShowRotationAxis"):
             if fp.ShowRotationAxis:
                 self.rot_axis.whichChild.setValue(coin.SO_SWITCH_ALL)
             else:
                 self.rot_axis.whichChild.setValue(coin.SO_SWITCH_NONE)
 
         elif prop == "AxisTransparency" and \
                 (hasattr(fp, "AxisColor") and hasattr(fp, "AxisTransparency")):
             self.rot_axis_color.orderedRGBA.setValue(
                 (round(0xff*fp.AxisColor[0]) << 24)
                 + (round(0xff*fp.AxisColor[1]) << 16)
                 + (round(0xff*fp.AxisColor[2]) << 8)
                 + 0xff*(100 - fp.AxisTransparency)//100)
 
         elif prop == "AxisColor" and \
                 (hasattr(fp, "AxisColor") and hasattr(fp, "AxisTransparency")):
             self.rot_axis_color.orderedRGBA.setValue(
                 (round(0xff*fp.AxisColor[0]) << 24)
                 + (round(0xff*fp.AxisColor[1]) << 16)
                 + (round(0xff*fp.AxisColor[2]) << 8)
                 + 0xff*(100 - fp.AxisTransparency)//100)
             self.axis_label_color.orderedRGBA.setValue(
                 (self.rot_axis_color.orderedRGBA.getValues()[0] & 0xFFFFFF00)
                 + 0xFF)
 
         elif prop == "AxisWidth" and hasattr(fp, "AxisWidth"):
             self.rot_axis_drawstyle.lineWidth.setValue(fp.AxisWidth)
 
         elif prop == "AxisLength" and hasattr(fp, "AxisLength"):
             self.rot_axis_shaft.vertexProperty.getValue().vertex.\
                 set1Value(1, 0, fp.AxisLength, 0)
             if hasattr(fp, "AxisArrowheadLength"):
                 self.rot_axis_arrowhead_translation.translation.setValue(
                     0, fp.AxisLength + fp.AxisArrowheadLength/2, 0)
             if not fp.ShowAxisArrowhead and hasattr(fp, "DistanceToAxis"):
                 self.label_translations[1].translation.setValue(
                     0, fp.AxisLength + fp.DistanceToAxis, 0)
 
         elif prop == "AxisArrowheadLength" and \
                 hasattr(fp, "AxisArrowheadLength"):
             self.rot_axis_arrowhead_cone.height.setValue(
                 fp.AxisArrowheadLength)
             if hasattr(fp, "AxisLength"):
                 self.rot_axis_arrowhead_translation.translation.setValue(
                     0, fp.AxisLength + fp.AxisArrowheadLength/2, 0)
             if fp.ShowAxisArrowhead and hasattr(fp, "DistanceToAxis"):
                 self.label_translations[1].translation.setValue(
                     0, fp.AxisArrowheadLength/2 + fp.DistanceToAxis, 0)
 
         elif prop == "AxisArrowheadRadius" and \
                 hasattr(fp, "AxisArrowheadRadius"):
             self.rot_axis_arrowhead_cone.bottomRadius.setValue(
                 fp.AxisArrowheadRadius)
 
         elif prop == "ShowAxisArrowhead" and hasattr(fp, "ShowAxisArrowhead"):
             if fp.ShowAxisArrowhead:
                 self.rot_axis_arrowhead.whichChild.setValue(
                     coin.SO_SWITCH_ALL)
                 if hasattr(fp, "AxisArrowheadLength") and \
                         hasattr(fp, "DistanceToAxis"):
                     self.label_translations[1].translation.setValue(
                         0, fp.AxisArrowheadLength/2 + fp.DistanceToAxis, 0)
             else:
                 self.rot_axis_arrowhead.whichChild.setValue(
                     coin.SO_SWITCH_NONE)
                 if hasattr(fp, "AxisLength") and hasattr(fp, "DistanceToAxis"):
                     self.label_translations[1].translation.setValue(
                         0, fp.AxisLength + fp.DistanceToAxis, 0)
 
         elif prop == "ShowAxisLabel" and hasattr(fp, "ShowAxisLabel"):
             if fp.ShowAxisLabel:
                 self.labels[-1].whichChild.setValue(coin.SO_SWITCH_ALL)
             else:
                 self.labels[-1].whichChild.setValue(coin.SO_SWITCH_NONE)
 
         # Changes to the labels
         elif prop == "Subscription" and hasattr(fp, "Subscription"):
             for l in self.label_texts:
                 l.string.setValues(2, 1, [fp.Subscription])
 
         elif prop == "Superscription" and hasattr(fp, "Superscription"):
             for l in self.label_texts:
                 l.string.setValues(0, 1, [fp.Superscription])
 
         elif prop == "FontFamily" and hasattr(fp, "FontFamily"):
             if fp.FontFamily == "SERIF":
                 self.font.family.setValue(self.font.SERIF)
             if fp.FontFamily == "SANS":
                 self.font.family.setValue(self.font.SANS)
             if fp.FontFamily == "TYPEWRITER":
                 self.font.family.setValue(self.font.TYPEWRITER)
 
         elif prop == "FontStyle" and hasattr(fp, "FontStyle"):
             if fp.FontStyle == "NONE":
                 self.font.style.setValue(self.font.NONE)
             if fp.FontStyle == "BOLD":
                 self.font.style.setValue(self.font.BOLD)
             if fp.FontStyle == "ITALIC":
                 self.font.style.setValue(self.font.ITALIC)
             if fp.FontStyle == "BOLD ITALIC":
                 self.font.style.setValue(self.font.BOLD | self.font.ITALIC)
 
         elif prop == "FontSize" and hasattr(fp, "FontSize"):
             self.font.size.setValue(fp.FontSize)
 
         elif prop == "DistanceToAxis" and hasattr(fp, "DistanceToAxis") and \
             hasattr(fp, "ShowFrameArrowheads") and \
                 hasattr(fp, "ShowAxisArrowhead"):
             if fp.ShowFrameArrowheads and hasattr(fp, "FrameArrowheadLength"):
                 self.label_translations[0].translation.setValue(
                     0, fp.FrameArrowheadLength/2 + fp.DistanceToAxis, 0)
             elif hasattr(fp, "ShaftLength"):
                 self.label_translations[0].translation.setValue(
                     0, fp.ShaftLength + fp.DistanceToAxis, 0)
             if fp.ShowAxisArrowhead and hasattr(fp, "AxisArrowheadLength"):
                 self.label_translations[1].translation.setValue(
                     0, fp.AxisArrowheadLength/2 + fp.DistanceToAxis, 0)
             elif hasattr(fp, "AxisLength"):
                 self.label_translations[1].translation.setValue(
                     0, fp.AxisLength + fp.DistanceToAxis, 0)
 

Member Data Documentation

◆ axis_label_color

Trajectory.ViewProviderTrajectoryProxy.axis_label_color

A SoPackedColor coloring a rotational axis(RA) label.

Definition at line 1408 of file Trajectory.py.

◆ font

Trajectory.ViewProviderTrajectoryProxy.font

A SoFontStyle font for axes labels.

Definition at line 937 of file Trajectory.py.

◆ fp

Trajectory.ViewProviderTrajectoryProxy.fp = None

static

A Trajectory object.

Definition at line 905 of file Trajectory.py.

◆ frame

Trajectory.ViewProviderTrajectoryProxy.frame

A SoSeparator with a coordinate frame made from 3 RGB arrows.

Definition at line 948 of file Trajectory.py.

◆ frame_arrowhead

Trajectory.ViewProviderTrajectoryProxy.frame_arrowhead

A SoSwitch translated cone for frame axes.

Definition at line 1446 of file Trajectory.py.

◆ frame_arrowhead_cone

Trajectory.ViewProviderTrajectoryProxy.frame_arrowhead_cone

A SoCone arrowhead cone for frame axes.

Definition at line 1445 of file Trajectory.py.

◆ frame_arrowhead_translation

Trajectory.ViewProviderTrajectoryProxy.frame_arrowhead_translation

A SoTranslation moving frame arrowheads.

Definition at line 1444 of file Trajectory.py.

◆ frame_color_x

Trajectory.ViewProviderTrajectoryProxy.frame_color_x

A SoPackedColor red color for an X axis.

Definition at line 1460 of file Trajectory.py.

◆ frame_color_y

Trajectory.ViewProviderTrajectoryProxy.frame_color_y

A SoPackedColor green color for an Y axis.

Definition at line 1461 of file Trajectory.py.

◆ frame_color_z

Trajectory.ViewProviderTrajectoryProxy.frame_color_z

A SoPackedColor blue color for an Z axis.

Definition at line 1462 of file Trajectory.py.

◆ frame_drawstyle

Trajectory.ViewProviderTrajectoryProxy.frame_drawstyle

A SoDrawStyle controlling frame axes shaft line width.

Definition at line 1484 of file Trajectory.py.

◆ frame_shaft

Trajectory.ViewProviderTrajectoryProxy.frame_shaft

A SoLineSet shaft for frame axes.

Definition at line 1437 of file Trajectory.py.

◆ label_texts

Trajectory.ViewProviderTrajectoryProxy.label_texts

A list of SoText2s labels denoting all axes and an origin.

Definition at line 1392 of file Trajectory.py.

◆ label_translations

Trajectory.ViewProviderTrajectoryProxy.label_translations

A list of SoTranslations moving labels.

Definition at line 1393 of file Trajectory.py.

◆ labels

Trajectory.ViewProviderTrajectoryProxy.labels

A list of SoSwitches containing colored translated labels.

Definition at line 1398 of file Trajectory.py.

◆ panel

Trajectory.ViewProviderTrajectoryProxy.panel = None

static

A TrajectoryPanel if one is active or None.

Definition at line 904 of file Trajectory.py.

◆ rot_axis

Trajectory.ViewProviderTrajectoryProxy.rot_axis

A SoSwitch with a rotation axis in form of an arrow.

Definition at line 942 of file Trajectory.py.

◆ rot_axis_arrowhead

Trajectory.ViewProviderTrajectoryProxy.rot_axis_arrowhead

A SoSwitch translated cone for a rotation axis.

Definition at line 1519 of file Trajectory.py.

◆ rot_axis_arrowhead_cone

Trajectory.ViewProviderTrajectoryProxy.rot_axis_arrowhead_cone

A SoCone arrowhead cone for a rotation axis.

Definition at line 1518 of file Trajectory.py.

◆ rot_axis_arrowhead_translation

Trajectory.ViewProviderTrajectoryProxy.rot_axis_arrowhead_translation

A SoTranslation moving a RA arrowhead.

Definition at line 1517 of file Trajectory.py.

◆ rot_axis_color

Trajectory.ViewProviderTrajectoryProxy.rot_axis_color

A SoPackedColor coloring a rotational axis.

Definition at line 1528 of file Trajectory.py.

◆ rot_axis_drawstyle

Trajectory.ViewProviderTrajectoryProxy.rot_axis_drawstyle

A SoDrawStyle controlling RA shaft line width.

Definition at line 1531 of file Trajectory.py.

◆ rot_axis_shaft

Trajectory.ViewProviderTrajectoryProxy.rot_axis_shaft

A SoLineSet shaft for a rotation axis.

Definition at line 1510 of file Trajectory.py.

◆ tf_object2world

Trajectory.ViewProviderTrajectoryProxy.tf_object2world

A SoTransform transformation from object to world frame.

Definition at line 934 of file Trajectory.py.

◆ tf_y2axis

Trajectory.ViewProviderTrajectoryProxy.tf_y2axis

A SoTransform transformation from Y axis to a rotation axis.

Definition at line 1525 of file Trajectory.py.

◆ visualisations

Trajectory.ViewProviderTrajectoryProxy.visualisations

A SoSwitch with all visualisations (frame & rotation axis).

Definition at line 951 of file Trajectory.py.

The documentation for this class was generated from the following file:

Doxypypy outputs/Trajectory.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getstate__()

◆ __setstate__()

◆ attach()

◆ canDropObject()

◆ claimChildren()

◆ doubleClicked()

◆ getIcon()

◆ makeFrame()

◆ makeLabels()

◆ makeRotationAxis()

◆ onChanged()

◆ setProperties()

◆ setupContextMenu()

◆ updateData()

Member Data Documentation

◆ axis_label_color

◆ font

◆ fp

◆ frame

◆ frame_arrowhead

◆ frame_arrowhead_cone

◆ frame_arrowhead_translation

◆ frame_color_x

◆ frame_color_y

◆ frame_color_z

◆ frame_drawstyle

◆ frame_shaft

◆ label_texts

◆ label_translations

◆ labels

◆ panel

◆ rot_axis

◆ rot_axis_arrowhead

◆ rot_axis_arrowhead_cone

◆ rot_axis_arrowhead_translation

◆ rot_axis_color

◆ rot_axis_drawstyle

◆ rot_axis_shaft

◆ tf_object2world

◆ tf_y2axis

◆ visualisations

◆ init()

◆ getstate()

◆ setstate()