draftlibs::fcgeo Namespace Reference

Functions
def	angleBisection
def	arcFromSpline
def	bind
def	circlefrom1Line2Points
def	circleFrom1tan1pt1rad
def	circleFrom1tan2pt
def	circlefrom2Lines1Point
def	circleFrom2LinesRadius
def	circleFrom2PointsRadius
def	circleFrom2tan1pt
def	circleFrom2tan1rad
def	circleFrom3CircleTangents
def	circleFrom3LineTangents
def	circleFrom3tan
def	circleFromPointLineRadius
def	circleInversion
def	cleanFaces
def	complexity
def	concatenate
def	connect
def	determinant
def	edg
def	findClosest
def	findClosestCircle
def	findDistance
def	findEdge
def	findHomotheticCenterOfCircles
def	findIntersection
def	findMidpoint
def	findPerpendicular
def	findRadicalAxis
def	findRadicalCenter
def	findWires
def	getBoundary
def	getBoundaryAngles
def	getCubicDimensions
def	getNormal
def	getTangent
def	getVerts
def	hasCurves
def	innerSoddyCircle
def	isCoplanar
def	isCubic
def	isNull
def	isPtOnEdge
def	isReallyClosed
def	linearFromPoints
def	mirror
def	offset
def	offsetWire
def	outerSoddyCircle
def	pointInversion
def	polarInversion
def	removeInterVertices
def	sortEdges
def	superWire
def	v1
def	vec
Variables
string	__author__ = "Yorik van Havre, Jacques-Antoine Gaudin, Ken Cline"
string	__title__ = "FreeCAD Draft Workbench - Geometry library"
list	__url__ = ["http://free-cad.sourceforge.net"]
tuple	NORM = Vector(0,0,1)
tuple	params = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Draft")
tuple	precision = params.GetInt("precision")

Function Documentation

def draftlibs::fcgeo::angleBisection	(	edge1,
		edge2
	)

Definition at line 786 of file fcgeo.py.

def draftlibs::fcgeo::arcFromSpline ( edge )

arcFromSpline(edge): turns the given edge into an arc, by taking
its first point, midpoint and endpoint. Works best with bspline
segments such as those from imported svg files. Use this only
if you are sure your edge is really an arc...

Definition at line 1074 of file fcgeo.py.

def draftlibs::fcgeo::bind	(	w1,
		w2
	)

bind(wire1,wire2): binds 2 wires by their endpoints and
returns a face

Definition at line 877 of file fcgeo.py.

Referenced by CmdSandboxMeshTestJob::activated(), CmdSandboxMeshLoaderBoost::activated(), Gui::Application::Application(), PartGui::CrossSections::apply(), App::DocumentObserver::attachDocument(), Gui::SelectionObserver::attachSelection(), PartDesignGui::ChamferWidget::ChamferWidget(), PartGui::DlgBooleanOperation::DlgBooleanOperation(), Gui::Dialog::DlgDisplayPropertiesImp::DlgDisplayPropertiesImp(), PartGui::DlgFilletEdges::DlgFilletEdges(), Gui::Document::Document(), Gui::DocumentItem::DocumentItem(), Gui::DocumentModel::DocumentModel(), Gui::DocumentObjectItem::DocumentObjectItem(), App::DocumentObserver::DocumentObserver(), App::DocumentObserverPython::DocumentObserverPython(), Inspection::Feature::execute(), MeshGui::ViewProviderMesh::getVisibleFacets(), Gui::MergeDocuments::MergeDocuments(), App::Application::newDocument(), Gui::SelectionSingleton::SelectionSingleton(), Gui::Application::slotNewDocument(), Gui::TaskView::TaskAppearance::TaskAppearance(), SketcherGui::TaskSketcherConstrains::TaskSketcherConstrains(), SketcherGui::TaskSketcherMessages::TaskSketcherMessages(), Gui::TaskView::TaskView::TaskView(), Gui::TreeWidget::TreeWidget(), and Gui::WorkbenchGroup::WorkbenchGroup().

def draftlibs::fcgeo::circlefrom1Line2Points	(	edge,
		p1,
		p2
	)

Definition at line 1216 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom1tan1pt1rad	(	tan1,
		p1,
		rad
	)

Definition at line 1179 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom1tan2pt	(	tan1,
		p1,
		p2
	)

Definition at line 1173 of file fcgeo.py.

def draftlibs::fcgeo::circlefrom2Lines1Point	(	edge1,
		edge2,
		point
	)

Definition at line 1209 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom2LinesRadius	(	edge1,
		edge2,
		radius
	)

Definition at line 1247 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom2PointsRadius	(	p1,
		p2,
		radius
	)

Definition at line 1361 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom2tan1pt	(	tan1,
		tan2,
		point
	)

Definition at line 1151 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom2tan1rad	(	tan1,
		tan2,
		rad
	)

Definition at line 1162 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom3CircleTangents	(	circle1,
		circle2,
		circle3
	)

http://en.wikipedia.org/wiki/Problem_of_Apollonius#Inversive_methods
http://mathworld.wolfram.com/ApolloniusCircle.html
http://mathworld.wolfram.com/ApolloniusProblem.html

Definition at line 1496 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom3LineTangents	(	edge1,
		edge2,
		edge3
	)

Definition at line 1269 of file fcgeo.py.

def draftlibs::fcgeo::circleFrom3tan	(	tan1,
		tan2,
		tan3
	)

Definition at line 1185 of file fcgeo.py.

def draftlibs::fcgeo::circleFromPointLineRadius	(	point,
		edge,
		radius
	)

Definition at line 1315 of file fcgeo.py.

def draftlibs::fcgeo::circleInversion	(	circle,
		circle2
	)

pointInversion(Circle, Circle)

Circle inversion of a circle.

Definition at line 1789 of file fcgeo.py.

def draftlibs::fcgeo::cleanFaces ( shape )

Definition at line 884 of file fcgeo.py.

def draftlibs::fcgeo::complexity ( obj )

tests given object for shape complexity:
1: line
2: arc
3: circle
4: open wire with no arc
5: closed wire
6: wire with arcs
7: faces
8: faces with arcs

Definition at line 543 of file fcgeo.py.

Referenced by Gui::SoBoxSelectionRenderActionP::initBoxGraph().

def draftlibs::fcgeo::concatenate ( shape )

Definition at line 348 of file fcgeo.py.

def draftlibs::fcgeo::connect	(	edges,
		closed = `False`
	)

connects the edges in the given list by their intersections

Definition at line 693 of file fcgeo.py.

def draftlibs::fcgeo::determinant	(	mat,
		n
	)

determinant(matrix,int) - Determinat function. Returns the determinant
of a n-matrix. It recursively expands the minors.

Definition at line 1572 of file fcgeo.py.

def draftlibs::fcgeo::edg	(	p1,
		p2
	)

Definition at line 51 of file fcgeo.py.

def draftlibs::fcgeo::findClosest	(	basepoint,
		pointslist
	)

findClosest(vector,list)
in a list of 3d points, finds the closest point to the base point.
an index from the list is returned.

Definition at line 333 of file fcgeo.py.

def draftlibs::fcgeo::findClosestCircle	(	point,
		circles
	)

Definition at line 810 of file fcgeo.py.

def draftlibs::fcgeo::findDistance	(	point,
		edge,
		strict = `False`
	)

findDistance(vector,edge,[strict]) - Returns a vector from the point to its
closest point on the edge. If strict is True, the vector will be returned
only if its endpoint lies on the edge.

Definition at line 730 of file fcgeo.py.

def draftlibs::fcgeo::findEdge	(	anEdge,
		aList
	)

findEdge(anEdge,aList): returns True if anEdge is found in aList of edges

Definition at line 127 of file fcgeo.py.

def draftlibs::fcgeo::findHomotheticCenterOfCircles	(	circle1,
		circle2
	)

findHomotheticCenterOfCircles(circle1, circle2)
Calculates the homothetic center(s) of two circles.

http://en.wikipedia.org/wiki/Homothetic_center
http://mathworld.wolfram.com/HomotheticCenter.html

Definition at line 1598 of file fcgeo.py.

def draftlibs::fcgeo::findIntersection	(	edge1,
		edge2,
		infinite1 = `False`,
		infinite2 = `False`,
		ex1 = `False`,
		ex2 = `False`
	)

findIntersection(edge1,edge2,infinite1=False,infinite2=False):
returns a list containing the intersection point(s) of 2 edges.
You can also feed 4 points instead of edge1 and edge2

Definition at line 137 of file fcgeo.py.

def draftlibs::fcgeo::findMidpoint ( edge )

Definition at line 513 of file fcgeo.py.

def draftlibs::fcgeo::findPerpendicular	(	point,
		edgeslist,
		force = `None`
	)

findPerpendicular(vector,wire,[force]):
finds the shortest perpendicular distance between a point and an edgeslist.
If force is specified, only the edge[force] will be considered, and it will be
considered infinite.
The function will return a list	[vector_from_point_to_closest_edge,edge_index]
or None if no perpendicular vector could be found.

Definition at line 572 of file fcgeo.py.

def draftlibs::fcgeo::findRadicalAxis	(	circle1,
		circle2
	)

Calculates the radical axis of two circles.
On the radical axis (also called power line) of two circles any
tangents drawn from a point on the axis to both circles have the same length.

http://en.wikipedia.org/wiki/Radical_axis
http://mathworld.wolfram.com/RadicalLine.html

@sa findRadicalCenter

Definition at line 1647 of file fcgeo.py.

def draftlibs::fcgeo::findRadicalCenter	(	circle1,
		circle2,
		circle3
	)

findRadicalCenter(circle1, circle2, circle3):
Calculates the radical center (also called the power center) of three circles.
It is the intersection point of the three radical axes of the pairs of circles.

http://en.wikipedia.org/wiki/Power_center_(geometry)
http://mathworld.wolfram.com/RadicalCenter.html

@sa findRadicalAxis

Definition at line 1699 of file fcgeo.py.

def draftlibs::fcgeo::findWires ( edges )

finds connected edges in the list, and returns a list of lists containing edges
that can be connected

Definition at line 831 of file fcgeo.py.

def draftlibs::fcgeo::getBoundary ( shape )

Definition at line 362 of file fcgeo.py.

def draftlibs::fcgeo::getBoundaryAngles	(	angle,
		alist
	)

returns the 2 closest angles from the list that
encompass the given angle

Definition at line 1109 of file fcgeo.py.

def draftlibs::fcgeo::getCubicDimensions ( shape )

getCubicDimensions(shape): returns a list containing the placement,
the length, the width and the height of a cubic shape. If not cubic, nothing
is returned. The placement point is the lowest corner of the shape.

Definition at line 1010 of file fcgeo.py.

def draftlibs::fcgeo::getNormal ( shape )

Definition at line 629 of file fcgeo.py.

def draftlibs::fcgeo::getTangent	(	edge,
		frompoint = `None`
	)

returns the tangent to an edge. If from point is given, it is used to
calculate the tangent (only useful for an arc of course).

Definition at line 862 of file fcgeo.py.

def draftlibs::fcgeo::getVerts ( shape )

Definition at line 57 of file fcgeo.py.

def draftlibs::fcgeo::hasCurves ( shape )

Definition at line 118 of file fcgeo.py.

def draftlibs::fcgeo::innerSoddyCircle	(	circle1,
		circle2,
		circle3
	)

Computes the inner soddy circle for three tightly packed circles.

Definition at line 1445 of file fcgeo.py.

def draftlibs::fcgeo::isCoplanar ( faces )

Definition at line 820 of file fcgeo.py.

def draftlibs::fcgeo::isCubic ( shape )

isCubic(shape): verifies if a shape is cubic, that is, has
8 vertices, 6 faces, and all angles are 90 degrees.

Definition at line 984 of file fcgeo.py.

def draftlibs::fcgeo::isNull ( something )

returns true if the given shape is null or the given placement is 0 or
if the given vector is (0,0,0)

Definition at line 68 of file fcgeo.py.

def draftlibs::fcgeo::isPtOnEdge	(	pt,
		edge
	)

isPtOnEdge(Vector,edge) -- Tests if a point is on an edge

Definition at line 84 of file fcgeo.py.

def draftlibs::fcgeo::isReallyClosed ( wire )

Definition at line 621 of file fcgeo.py.

def draftlibs::fcgeo::linearFromPoints	(	p1,
		p2
	)

Calculate linear equation from points.
Calculate the slope and offset parameters of the linear equation of a line defined by two points.

Linear equation:
y = m * x + b
m = dy / dx
m ... Slope
b ... Offset (point where the line intersects the y axis)
dx/dy ... Delta x and y. Using both as a vector results in a non-offset direction vector.

Definition at line 1549 of file fcgeo.py.

def draftlibs::fcgeo::mirror	(	point,
		edge
	)

Definition at line 322 of file fcgeo.py.

def draftlibs::fcgeo::offset	(	edge,
		vector
	)

offset(edge,vector)
returns a copy of the edge at a certain (vector) distance
if the edge is an arc, the vector will be added at its first point
and a complete circle will be returned

Definition at line 603 of file fcgeo.py.

def draftlibs::fcgeo::offsetWire	(	wire,
		dvec,
		bind = `False`,
		occ = `False`
	)

offsetWire(wire,vector,[bind]): offsets the given wire along the
given vector. The vector will be applied at the first vertex of
the wire. If bind is True (and the shape is open), the original
wire and the offsetted one are bound by 2 edges, forming a face.

Definition at line 652 of file fcgeo.py.

def draftlibs::fcgeo::outerSoddyCircle	(	circle1,
		circle2,
		circle3
	)

Computes the outer soddy circle for three tightly packed circles.

Definition at line 1393 of file fcgeo.py.

def draftlibs::fcgeo::pointInversion	(	circle,
		point
	)

pointInversion(Circle, Vector)

Circle inversion of a point.
Will calculate the inversed point an return it.
If the given point is equal to the center of the circle "None" will be returned.

See also:
http://en.wikipedia.org/wiki/Inversive_geometry

Definition at line 1731 of file fcgeo.py.

def draftlibs::fcgeo::polarInversion	(	circle,
		edge
	)

polarInversion(circle, edge):
Returns the inversion pole of a line.
edge ... The polar.
i.e. The nearest point on the line is inversed.

http://mathworld.wolfram.com/InversionPole.html

Definition at line 1767 of file fcgeo.py.

def draftlibs::fcgeo::removeInterVertices ( wire )

removeInterVertices(wire) - remove unneeded vertices (those that
are in the middle of a straight line) from a wire, returns a new wire.

Definition at line 1051 of file fcgeo.py.

def draftlibs::fcgeo::sortEdges	(	lEdges,
		aVertex = `None`
	)

Definition at line 380 of file fcgeo.py.

def draftlibs::fcgeo::superWire	(	edgeslist,
		closed = `False`
	)

superWire(edges,[closed]): forces a wire between edges that don't necessarily
have coincident endpoints. If closed=True, wire will always be closed

Definition at line 459 of file fcgeo.py.

def draftlibs::fcgeo::v1 ( edge )

Definition at line 64 of file fcgeo.py.

Referenced by Mesh::MeshPy::addFacet(), annRanGauss(), Part::GeometrySurfacePy::bounds(), Part::BSplineSurfacePy::bounds(), Part::BezierSurfacePy::bounds(), SandboxGui::SoWidgetShape::computeBBox(), KDL::cos(), KDL::cosh(), SketcherGui::ViewProviderSketch::draw(), MeshGui::SoFCIndexedFaceSet::drawCoords(), Sketcher::SketchObjectPy::fillet(), SandboxGui::SoWidgetShape::generatePrimitives(), Part::TopoShape::getFaces(), Part::TopoShape::getFacesFromSubelement(), Part::TopoShapeFacePy::getParameterRange(), Gui::SoTextLabel::GLRender(), InspectionGui::ViewProviderInspection::inspectDistance(), Part::BSplineCurvePy::interpolate(), MeshCore::MeshGeomFacet::IntersectBoundingBox(), MeshCore::MeshGeomFacet::IntersectWithPlane(), Part::TopoShape::makeTube(), best_fit::MeshFit_Coarse(), Part::TopoShapePy::mirror(), Sketcher::SketchObjectPy::movePoint(), best_fit::PointCloud_Coarse(), Part::TopoShapeEdgePy::PyInit(), Base::RotationPy::PyInit(), Part::RectangularTrimmedSurfacePy::PyInit(), Part::PlanePy::PyInit(), Part::LinePy::PyInit(), Part::HyperbolaPy::PyInit(), Part::EllipsePy::PyInit(), Part::CylinderPy::PyInit(), Part::ConePy::PyInit(), Part::CirclePy::PyInit(), Base::BoundBoxPy::PyInit(), Part::ArcPy::PyInit(), Part::ArcOfCirclePy::PyInit(), MeshCore::MeshKernel::Read(), Base::VectorPy::richCompare(), Part::BSplineSurfacePy::segment(), Part::BezierSurfacePy::segment(), KDL::sin(), KDL::sinh(), Mesh::MeshPy::splitFacet(), MeshCore::MeshTopoAlgorithm::SwapEdgeBenefit(), KDL::tan(), KDL::tanh(), Part::GeometrySurfacePy::toShape(), Part::GeomSurface::toShape(), PartGui::ViewProviderPartBase::transferToArray(), Raytracing::PovTools::transferToArray(), Sketcher::SketchObjectPy::trim(), and PartGui::ViewProviderPartExt::updateVisual().

def draftlibs::fcgeo::vec ( edge )

Definition at line 41 of file fcgeo.py.

Referenced by Base::VectorPy::add(), PartGui::DlgExtrusion::apply(), Part::BSplineCurvePy::approximate(), path_simulate::ConnectPaths_Feat(), ReadDyna::Convert(), Base::VectorPy::cross(), Base::VectorPy::dot(), PartDesign::Pocket::execute(), PartDesign::Pad::execute(), Part::Extrusion::execute(), Part::TopoShapePy::extrude(), Base::VectorPy::getAngle(), Part::BSplineSurfacePy::getPole(), Part::BSplineCurvePy::getPole(), Part::BezierCurvePy::getPole(), Part::BSplineCurvePy::getPoles(), Part::BezierCurvePy::getPoles(), Mesh::MeshPointPy::getVector(), Robot::Trajectory::getVelocity(), Part::BezierCurvePy::insertPoleAfter(), Part::BezierCurvePy::insertPoleBefore(), Base::BoundBoxPy::isInside(), loftOnCurve(), makeBox(), makeCircle(), makeCone(), makeCylinder(), makePlane(), makeRevolution(), Part::TopoShapePy::makeShapeFromMesh(), makeSphere(), makeTorus(), makeWedge(), best_fit::MeshFit_Coarse(), Part::GeometryPy::mirror(), SketcherGui::ViewProviderSketch::mouseMove(), Base::PlacementPy::move(), Mesh::MeshPointPy::move(), Base::MatrixPy::move(), Base::BoundBoxPy::move(), SketcherGui::ViewProviderSketch::moveConstraint(), Mesh::MeshObject::movePoint(), Base::MatrixPy::multiply(), Base::RotationPy::multVec(), Base::PlacementPy::multVec(), Part::TopoShapeFacePy::normalAt(), Gui::Dialog::DemoMode::on_playButton_clicked(), best_fit::PointCloud_Coarse(), Base::MatrixPy::scale(), Part::GeometryPy::scale(), Part::BSplineSurfacePy::setPole(), Part::BSplineCurvePy::setPole(), Part::BezierCurvePy::setPole(), App::PropertyVectorList::setPyObject(), App::PropertyVector::setPyObject(), Part::TopoShapePy::slice(), Part::TopoShapePy::slices(), Base::VectorPy::sub(), path_simulate::TimeCorrection(), Base::MatrixPy::transform(), Part::TopoShapePy::translate(), and Part::GeometryPy::translate().

Variable Documentation

string draftlibs::fcgeo::__author__ = "Yorik van Havre, Jacques-Antoine Gaudin, Ken Cline"

Definition at line 25 of file fcgeo.py.

string draftlibs::fcgeo::__title__ = "FreeCAD Draft Workbench - Geometry library"

Definition at line 24 of file fcgeo.py.

list draftlibs::fcgeo::__url__ = ["http://free-cad.sourceforge.net"]

Definition at line 26 of file fcgeo.py.

tuple draftlibs::fcgeo::NORM = Vector(0,0,1)

Definition at line 33 of file fcgeo.py.

tuple draftlibs::fcgeo::params = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Draft")

Definition at line 35 of file fcgeo.py.

tuple draftlibs::fcgeo::precision = params.GetInt("precision")

Definition at line 36 of file fcgeo.py.

Referenced by Approximate::eFair2().

draftlibs::fcgeo Namespace Reference

Functions

Variables

Function Documentation

Variable Documentation