draftTools Namespace Reference

Classes
class	AddPoint
class	AddToGroup
class	ApplyStyle
class	Arc
class	arcTracker
class	BSpline
class	bsplineTracker
class	Circle
class	CloseLine
class	Creator
class	DelPoint
class	Dimension
class	dimTracker
class	Downgrade
class	Drawing
class	Edit
class	editTracker
class	FinishLine
class	ghostTracker
class	gridTracker
class	Line
class	lineTracker
class	Modifier
class	Move
class	Offset
class	PlaneTracker
class	Polygon
class	Rectangle
class	rectangleTracker
class	Rotate
class	Scale
class	SelectGroup
class	SelectPlane
class	Shape2DView
class	snapTracker
class	Text
class	ToggleConstructionMode
class	ToggleContinueMode
class	ToggleDisplayMode
class	Tracker
class	Trimex
class	UndoLine
class	Upgrade
class	Wire
class	WireToBSpline
class	wireTracker
Functions
def	constrainPoint
def	getPoint
def	getSupport
def	hasMod
def	msg
def	selectObject
def	setMod
def	snapPoint
def	translate
Variables
string	__author__ = "Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, Dmitry Chigrin"
string	__title__ = "FreeCAD Draft Workbench GUI Tools"
string	__url__ = "http://free-cad.sourceforge.net"
tuple	altpat = Draft.getParam("patternFile")
tuple	defaultWP = Draft.getParam("defaultWP")
list	lastObj = [0,0]
list	MODALT = MODS[Draft.getParam("modalt")]
list	MODCONSTRAIN = MODS[Draft.getParam("modconstrain")]
list	MODS = ["shift","ctrl","alt"]
list	MODSNAP = MODS[Draft.getParam("modsnap")]
tuple	p = importSVG.getContents(altpat+os.sep+f,'pattern')
tuple	plane = WorkingPlane.plane()

---

Function Documentation

def draftTools::constrainPoint	(		target,
			pt,
			mobile = False,
			sym = False
	)

Constrain function used by the Draft tools
On commands that need to enter several points (currently only line/wire),
you can constrain the next point to be picked to the last drawn point by
pressing SHIFT. The vertical or horizontal constraining depends on the
position of your mouse in relation to last point at the moment you press
SHIFT. if mobile=True, mobile behaviour applies. If sym=True, x alway = y

Definition at line 314 of file draftTools.py.

def draftTools::getPoint	(		target,
			args,
			mobile = False,
			sym = False,
			workingplane = True
	)

Function used by the Draft Tools.
returns a constrained 3d point and its original point.
if mobile=True, the constraining occurs from the location of
mouse cursor when Shift is pressed, otherwise from last entered
point. If sym=True, x and y values stay always equal. If workingplane=False,
the point wont be projected on the Working Plane.

Definition at line 412 of file draftTools.py.

def draftTools::getSupport

(

args

)

Definition at line 459 of file draftTools.py.

def draftTools::hasMod	(		args,
			mod
	)

Definition at line 476 of file draftTools.py.

def draftTools::msg	(		text = None,
			mode = None
	)

Definition at line 50 of file draftTools.py.

Referenced by StdCmdWorkbench::activated(), CmdMeshEvaluateSolid::activated(), Gui::Application::activateWorkbench(), Gui::MainWindow::customEvent(), CustomReportEvent::CustomReportEvent(), Sketcher::SketchObject::execute(), ProgramOptions::failure(), DOMPrintErrorHandler::handleError(), initFreeCAD(), Gui::SplashObserver::Log(), Gui::DockWnd::ReportOutput::Log(), main(), CustomReportEvent::message(), Gui::CustomMessageEvent::message(), TestGui::UnitTestDialog::on_startButton_clicked(), Gui::Dialog::DlgTipOfTheDayImp::onResponseHeaderReceived(), SketcherGui::ViewProviderSketch::setEdit(), Gui::MainWindow::showMessage(), SketcherGui::ViewProviderSketch::updateData(), Gui::PythonDebugStderr::write(), and Gui::PythonDebugStdout::write().

def draftTools::selectObject

(

arg

)

this is a scene even handler, to be called from the Draft tools
when they need to select an object

Definition at line 395 of file draftTools.py.

def draftTools::setMod	(		args,
			mod,
			state
	)

Definition at line 485 of file draftTools.py.

def draftTools::snapPoint	(		target,
			point,
			cursor,
			ctrl = False
	)

Snap function used by the Draft tools

Currently has two modes: passive and active. Pressing CTRL while 
clicking puts you in active mode:

- In passive mode (an open circle appears), your point is
snapped to the nearest point on any underlying geometry.

- In active mode (ctrl pressed, a filled circle appears), your point
can currently be snapped to the following points:
    - Nodes and midpoints of all Part shapes
    - Nodes and midpoints of lines/wires
    - Centers and quadrant points of circles
    - Endpoints of arcs
    - Intersection between line, wires segments, arcs and circles
    - When constrained (SHIFT pressed), Intersections between
    constraining axis and lines/wires

Definition at line 91 of file draftTools.py.

def draftTools::translate	(		context,
			text
	)

Definition at line 46 of file draftTools.py.

---

Variable Documentation

string draftTools::__author__ = "Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, Dmitry Chigrin"

Definition at line 25 of file draftTools.py.

string draftTools::__title__ = "FreeCAD Draft Workbench GUI Tools"

Definition at line 24 of file draftTools.py.

string draftTools::__url__ = "http://free-cad.sourceforge.net"

Definition at line 26 of file draftTools.py.

tuple draftTools::altpat = Draft.getParam("patternFile")

Definition at line 63 of file draftTools.py.

tuple draftTools::defaultWP = Draft.getParam("defaultWP")

Definition at line 73 of file draftTools.py.

list draftTools::lastObj = [0,0]

Definition at line 79 of file draftTools.py.

list draftTools::MODALT = MODS[Draft.getParam("modalt")]

Definition at line 85 of file draftTools.py.

list draftTools::MODCONSTRAIN = MODS[Draft.getParam("modconstrain")]

Definition at line 83 of file draftTools.py.

list draftTools::MODS = ["shift","ctrl","alt"]

Definition at line 82 of file draftTools.py.

list draftTools::MODSNAP = MODS[Draft.getParam("modsnap")]

Definition at line 84 of file draftTools.py.

tuple draftTools::p = importSVG.getContents(altpat+os.sep+f,'pattern')

Definition at line 67 of file draftTools.py.

Referenced by KDL::Path_Circle::Acc(), CmdSketcherNewSketch::activated(), CmdTestGrabWidget::activated(), CmdApproxSurface::activated(), Py::ExtensionClassMethodsTable::add_method(), Sketcher::Sketch::addCoordinateXConstraint(), Sketcher::Sketch::addCoordinateYConstraint(), MeshCore::MeshBuilder::AddFacet(), Mesh::MeshPy::addFacets(), Mesh::MeshObject::addFacets(), InspectionGui::addFlag(), Points::PointsPy::addPoints(), Gui::MainWindow::addWindow(), Gui::StatusWidget::adjustPosition(), annAllocPt(), annAllocPts(), annCopyPt(), Reen::BSplineBasis::BasisFunction(), Py::PythonClass< PythonBaseClass >::behaviors(), Py::PythonExtension< StdMeshers_Deflection1DPy >::behaviors(), MeshCore::MeshAlgorithm::CheckFacets(), Py::compare_handler(), UniGridApprox::CompKnots(), path_simulate::ConnectPaths_xy(), Part::PropertyFilletEdges::Copy(), App::PropertyMaterial::Copy(), App::PropertyColorList::Copy(), App::PropertyColor::Copy(), App::PropertyBool::Copy(), App::PropertyStringList::Copy(), App::PropertyString::Copy(), App::PropertyFloatList::Copy(), App::PropertyFloat::Copy(), App::PropertyIntegerList::Copy(), App::PropertyPath::Copy(), App::PropertyInteger::Copy(), App::PropertyPythonObject::Copy(), App::PropertyLinkSubList::Copy(), App::PropertyLinkList::Copy(), App::PropertyLinkSub::Copy(), App::PropertyLink::Copy(), Part::PropertyGeometryList::Copy(), App::PropertyPlacementLink::Copy(), App::PropertyPlacement::Copy(), App::PropertyMatrix::Copy(), App::PropertyVectorList::Copy(), App::PropertyVector::Copy(), App::PropertyFileIncluded::Copy(), Sketcher::PropertyConstraintList::Copy(), Mesh::PropertyCurvatureList::Copy(), MeshPart::Mesher::createMesh(), Gui::PropertyEditor::PropertyColorItem::decoration(), Py::Object::decrement_reference_count(), Py::Object::delAttr(), Reen::BSplineBasis::DerivativeOfBasisFunction(), Reen::BSplineBasis::DerivativesOfBasisFunction(), Part::GeometryCurvePy::discretize(), MeshCore::MeshGeomFacet::DistanceToLineSegment(), doClipping(), Gui::CallTipsList::eventFilter(), ANNpr_queue::extr_min(), path_simulate::Gen_Path(), Part::GeomParabola::GeomParabola(), Py::Object::getAttr(), Py::getattr_handler(), Py::getattro_handler(), MeshCore::MeshRefPointToPoints::GetAverageEdgeLength(), Part::TopoShape::getFaces(), Py::Object::getItem(), Part::TopoShapeVertexPy::getPoint(), Inspection::InspectActualPoints::getPoint(), Part::BezierSurfacePy::getPole(), Part::GeomBSplineCurve::getPoles(), Part::BSplineSurfacePy::getPoles(), Part::BSplineCurvePy::getPoles(), Part::BezierSurfacePy::getPoles(), Part::BezierCurvePy::getPoles(), App::PropertyString::getPyObject(), App::PropertyPath::getPyObject(), App::PropertyFileIncluded::getPyObject(), App::DocumentPy::getTempFileName(), Part::TopoShape::getTransform(), Py::Object::hasAttr(), Py::Object::hashValue(), iisFreeCADTaskPanelScheme::iisFreeCADTaskPanelScheme(), Py::Object::increment_reference_count(), Gui::PolyPickerSelection::initialize(), Sketcher::Sketch::initMove(), ANNpr_queue::insert(), Part::BezierCurvePy::insertPoleAfter(), Part::BezierCurvePy::insertPoleBefore(), Part::BezierSurfacePy::insertPoleColAfter(), Part::BezierSurfacePy::insertPoleColBefore(), Part::BezierSurfacePy::insertPoleRowAfter(), Part::BezierSurfacePy::insertPoleRowBefore(), InspectionGui::ViewProviderInspection::inspectDistance(), MeshCore::MeshGeomEdge::IntersectBoundingBox(), MeshCore::MeshGeomFacet::IntersectWithPlane(), Base::PlacementPy::inverse(), Base::Placement::inverse(), Py::Object::is(), Py::Object::isBoolean(), Py::Object::isCallable(), Py::Object::isDict(), PartDesign::SketchBased::isInside(), Py::Object::isInstance(), Py::Object::isList(), Py::Object::isMapping(), Py::Object::isNone(), Py::Object::isNumeric(), MeshCore::MeshGeomFacet::IsPointOfFace(), Py::Object::isSequence(), Py::Object::isString(), Py::Object::isTrue(), Py::Object::isTuple(), Py::Object::isUnicode(), makeBox(), makeCone(), makeCylinder(), makePlane(), makeRevolution(), makeSphere(), makeTorus(), makeWedge(), UniGridApprox::MatComp(), Gui::BitmapFactoryInst::merge(), Part::BSplineSurfacePy::movePoint(), Part::BSplineCurvePy::movePoint(), Py::new_reference_to(), Py::Object::Object(), Gui::Dialog::DlgCustomActionsImp::on_actionListWidget_itemActivated(), Points::Feature::onChanged(), Part::Feature::onChanged(), Mesh::Feature::onChanged(), Py::Object::operator!=(), Py::Object::operator*(), KDL::Frame::operator*(), Py::Object::operator<(), Base::Reference< MeshObject >::operator<(), Py::Object::operator<=(), Py::Object::operator==(), Py::Object::operator>(), Py::Object::operator>=(), Gui::ColorButton::paintEvent(), iisTaskPanel::paintEvent(), iisTaskHeader::paintEvent(), iisTaskGroup::paintEvent(), iisTaskBox::paintEvent(), iisIconLabel::paintEvent(), Gui::Flag::paintEvent(), DrawingGui::SvgView::paintEvent(), Part::GeometrySurfacePy::parameter(), Part::GeometryCurvePy::parameter(), path_simulate::path_simulate(), Gui::BitmapFactoryInst::pixmapFromSvg(), KDL::Path_Circle::Pos(), Part::Part2DObject::positionBySupport(), Gui::View3DInventor::print(), DrawingGui::DrawingView::print(), Py::print_handler(), Py::Object::ptr(), Base::PyAsUnicodeObject(), Base::RotationPy::PyInit(), Base::PlacementPy::PyInit(), GCS::SubSystem::redirectParams(), Py::Object::reference_count(), Py::Object::release(), Mesh::Interface< Kernel >::release(), Gui::Dialog::DlgPreferencesImp::removePage(), SketcherGui::DrawSketchHandler::renderSuggestConstraintsCursor(), Approximate::Reparam(), Part::Box::Restore(), MeshCore::MeshOutput::SavePLY(), Part::TopoShapePy::scale(), Part::Part2DObject::seekTrimPoints(), Py::Object::set(), Py::Object::setAttr(), Py::setattr_handler(), Py::setattro_handler(), Part::ToroidPy::setAxis(), Part::SpherePy::setAxis(), Part::PlanePy::setAxis(), Part::ParabolaPy::setAxis(), Part::HyperbolaPy::setAxis(), Part::EllipsePy::setAxis(), Part::CylinderPy::setAxis(), Part::ConePy::setAxis(), Part::CirclePy::setAxis(), Part::ArcOfCirclePy::setAxis(), Part::SurfaceOfRevolutionPy::setBasisCurve(), Part::SurfaceOfExtrusionPy::setBasisCurve(), Part::OffsetCurvePy::setBasisCurve(), Part::OffsetSurfacePy::setBasisSurface(), Part::ToroidPy::setCenter(), Part::SpherePy::setCenter(), Part::EllipsePy::setCenter(), Part::CylinderPy::setCenter(), Part::ConePy::setCenter(), Part::CirclePy::setCenter(), Part::ArcOfCirclePy::setCenter(), RobotGui::TaskRobot6Axis::setColor(), PartGui::ViewProviderCrossSections::setCoords(), Part::SurfaceOfRevolutionPy::setDirection(), Part::SurfaceOfExtrusionPy::setDirection(), RobotGui::TaskEdge2TracParameter::setEdgeAndClusterNbr(), Part::LinePy::setEndPoint(), App::PropertyEnumeration::setEnums(), Mesh::MeshObject::setFacets(), Part::SurfaceOfRevolutionPy::setLocation(), Part::ParabolaPy::setLocation(), Part::HyperbolaPy::setLocation(), Data::ComplexGeoDataPy::setMatrix(), Part::OffsetCurvePy::setOffsetDirection(), Data::ComplexGeoDataPy::setPlacement(), Part::BSplineSurfacePy::setPole(), Part::BSplineCurvePy::setPole(), Part::BezierCurvePy::setPole(), Part::BSplineSurfacePy::setPoleCol(), Part::BezierSurfacePy::setPoleCol(), Part::BSplineSurfacePy::setPoleRow(), Part::BezierSurfacePy::setPoleRow(), Part::PlanePy::setPosition(), App::PropertyPlacement::setPyObject(), Part::LinePy::setStartPoint(), Robot::Robot6AxisPy::setTcp(), Gui::ViewProviderPy::setTransformation(), Gui::ToolBoxManager::setup(), MeshGui::Annotation::show(), PartGui::ViewProviderPartBase::showControlPointsOfEdge(), KDL::svd_eigen_Macie(), InspectionGui::ViewProviderInspection::updateData(), Gui::ViewProviderGeometryObject::updateData(), PartGui::ViewProviderPartExt::updateVisual(), useMesh(), Part::GeometrySurfacePy::value(), Part::GeometryCurvePy::value(), KDL::Path_Circle::Vel(), Gui::View3DInventorPy::viewPosition(), and MeshVRML::WriteVRMLViewpoints().

tuple draftTools::plane = WorkingPlane.plane()

Definition at line 71 of file draftTools.py.

Referenced by Gui::NavigationStyle::boxZoom(), Mesh::MeshPy::crossSections(), doClipping(), Part::TopoShapeFacePy::getSurface(), Part::Part2DObject::positionBySupport(), Part::PlanePy::PyInit(), Part::Part2DObject::seekTrimPoints(), Part::PlanePy::uIso(), and Part::PlanePy::vIso().