draftguitools.gui_edit_base_object.GuiTools Class Reference

Public Member Functions
def	get_edit_obj_context_menu (self, edit_command, obj, position)
def	get_edit_point_context_menu (self, edit_command, obj, node_idx)
def	get_edit_points (self, obj)
def	get_object_style (self, obj)
def	init_preview_object (self, obj)
def	restore_object_style (self, obj, modes)
def	set_object_editing_style (self, obj)
def	update_object_from_edit_points (self, obj, node_idx, v, alt_edit_mode=0)
def	update_preview_object (self, edit_command, obj, node_idx, v)

Detailed Description

 Base class for object editing tools

Member Function Documentation

get_edit_obj_context_menu()

def draftguitools.gui_edit_base_object.GuiTools.get_edit_obj_context_menu	(		self,
			edit_command,
			obj,
			position
	)

 Get the context menu associated to edited object (user is over the object)

Return a list of tuples containing menu labels and associated functions:
    return [
        ("action label", lambda: self.handle_action_label(edit_command, obj, position)),
    ]

Parameters:
edit_command: running Draft_Edit command
obj: the edited object
position: position of the cursor on the screen (x, y)

Reimplemented in draftguitools.gui_edit_draft_objects.DraftWireGuiTools, draftguitools.gui_edit_draft_objects.DraftCircleGuiTools, and draftguitools.gui_edit_draft_objects.DraftBezCurveGuiTools.

get_edit_point_context_menu()

def draftguitools.gui_edit_base_object.GuiTools.get_edit_point_context_menu	(		self,
			edit_command,
			obj,
			node_idx
	)

 Get the context menu associated to edit points (user is over an editpoint)

Return a list of tuples containing menu labels and associated functions:
    return [
        ("action label", lambda: self.handle_action_label(edit_command, obj, node_idx)),
    ]

Parameters:
edit_command: running Draft_Edit command
obj: the edited object
node_idx: number of the edited node

Reimplemented in draftguitools.gui_edit_draft_objects.DraftWireGuiTools, draftguitools.gui_edit_draft_objects.DraftCircleGuiTools, and draftguitools.gui_edit_draft_objects.DraftBezCurveGuiTools.

get_edit_points()

def draftguitools.gui_edit_base_object.GuiTools.get_edit_points	(		self,
			obj
	)

Return to Draft_Edit a list of vectors for the given object.
Remember to use object local coordinates system.

Parameters:
obj: the object

Reimplemented in draftguitools.gui_edit_arch_objects.ArchWallGuiTools, draftguitools.gui_edit_arch_objects.ArchWindowGuiTools, draftguitools.gui_edit_arch_objects.ArchStructureGuiTools, draftguitools.gui_edit_arch_objects.ArchSpaceGuiTools, draftguitools.gui_edit_arch_objects.ArchPanelCutGuiTools, draftguitools.gui_edit_arch_objects.ArchPanelSheetGuiTools, draftguitools.gui_edit_draft_objects.DraftWireGuiTools, draftguitools.gui_edit_draft_objects.DraftRectangleGuiTools, draftguitools.gui_edit_draft_objects.DraftCircleGuiTools, draftguitools.gui_edit_draft_objects.DraftEllipseGuiTools, draftguitools.gui_edit_draft_objects.DraftPolygonGuiTools, draftguitools.gui_edit_draft_objects.DraftDimensionGuiTools, draftguitools.gui_edit_draft_objects.DraftBezCurveGuiTools, draftguitools.gui_edit_part_objects.PartLineGuiTools, draftguitools.gui_edit_part_objects.PartBoxGuiTools, draftguitools.gui_edit_part_objects.PartCylinderGuiTools, draftguitools.gui_edit_part_objects.PartConeGuiTools, draftguitools.gui_edit_part_objects.PartSphereGuiTools, and draftguitools.gui_edit_sketcher_objects.SketcherSketchObjectGuiTools.

get_object_style()

def draftguitools.gui_edit_base_object.GuiTools.get_object_style	(		self,
			obj
	)

Reimplemented in draftguitools.gui_edit_arch_objects.ArchStructureGuiTools.

init_preview_object()

def draftguitools.gui_edit_base_object.GuiTools.init_preview_object	(		self,
			obj
	)

Reimplemented in draftguitools.gui_edit_draft_objects.DraftWireGuiTools, draftguitools.gui_edit_draft_objects.DraftBSplineGuiTools, draftguitools.gui_edit_draft_objects.DraftCircleGuiTools, and draftguitools.gui_edit_draft_objects.DraftBezCurveGuiTools.

restore_object_style()

def draftguitools.gui_edit_base_object.GuiTools.restore_object_style	(		self,
			obj,
			modes
	)

Reimplemented in draftguitools.gui_edit_arch_objects.ArchStructureGuiTools.

set_object_editing_style()

def draftguitools.gui_edit_base_object.GuiTools.set_object_editing_style	(		self,
			obj
	)

Reimplemented in draftguitools.gui_edit_arch_objects.ArchStructureGuiTools.

update_object_from_edit_points()

def draftguitools.gui_edit_base_object.GuiTools.update_object_from_edit_points	(		self,
			obj,
			node_idx,
			v,
			alt_edit_mode = 0
	)

Update the object from modified Draft_Edit point.
No need to recompute at the end.

Parameters:
obj: the object
node_idx: number of the edited node
v: target vector of the node in object local coordinates system
alt_edit_mode: alternative edit mode to perform different operations
               (usually can be selected from the Draft_Edit context menu)
               default = 0

Reimplemented in draftguitools.gui_edit_arch_objects.ArchWallGuiTools, draftguitools.gui_edit_arch_objects.ArchWindowGuiTools, draftguitools.gui_edit_arch_objects.ArchStructureGuiTools, draftguitools.gui_edit_arch_objects.ArchSpaceGuiTools, draftguitools.gui_edit_arch_objects.ArchPanelCutGuiTools, draftguitools.gui_edit_arch_objects.ArchPanelSheetGuiTools, draftguitools.gui_edit_draft_objects.DraftWireGuiTools, draftguitools.gui_edit_draft_objects.DraftRectangleGuiTools, draftguitools.gui_edit_draft_objects.DraftCircleGuiTools, draftguitools.gui_edit_draft_objects.DraftEllipseGuiTools, draftguitools.gui_edit_draft_objects.DraftPolygonGuiTools, draftguitools.gui_edit_draft_objects.DraftDimensionGuiTools, draftguitools.gui_edit_draft_objects.DraftBezCurveGuiTools, draftguitools.gui_edit_part_objects.PartLineGuiTools, draftguitools.gui_edit_part_objects.PartBoxGuiTools, draftguitools.gui_edit_part_objects.PartCylinderGuiTools, draftguitools.gui_edit_part_objects.PartConeGuiTools, draftguitools.gui_edit_part_objects.PartSphereGuiTools, and draftguitools.gui_edit_sketcher_objects.SketcherSketchObjectGuiTools.

update_preview_object()

def draftguitools.gui_edit_base_object.GuiTools.update_preview_object	(		self,
			edit_command,
			obj,
			node_idx,
			v
	)

Reimplemented in draftguitools.gui_edit_draft_objects.DraftWireGuiTools, draftguitools.gui_edit_draft_objects.DraftBSplineGuiTools, draftguitools.gui_edit_draft_objects.DraftCircleGuiTools, and draftguitools.gui_edit_draft_objects.DraftBezCurveGuiTools.

---

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

• FreeCAD/src/Mod/Draft/draftguitools/gui_edit_base_object.py