PathScripts.PathGeom.Side Class Reference

Public Member Functions
def	of (cls, ptRef, pt)
def	toString (cls, side)

Static Public Attributes
int	Left = +1
int	On = 0
int	Right = -1
int	Straight = 0

Detailed Description

Class to determine and define the side a Path is on, or Vectors are in relation to each other.

Member Function Documentation

of()

def PathScripts.PathGeom.Side.of	(		cls,
			ptRef,
			pt
	)

of(ptRef, pt)
Determine the side of pt in relation to ptRef.
If both Points are viewed as vectors with their origin in (0,0,0)
then the two vectors either form a straight line (On) or pt
lies in the left or right hemisphere in regards to ptRef.

References Gui::Camera.Left, PathScripts.PathDressupDogbone.Side.Left, PathScripts.PathGeom.Side.Left, Gui::Camera.Right, PathScripts.PathDressupDogbone.Side.Right, PathScripts.PathGeom.Side.Right, and PathScripts.PathGeom.Side.Straight.

toString()

def PathScripts.PathGeom.Side.toString	(		cls,
			side
	)

toString(side)
Returns a string representation of the enum value.

References Gui::Camera.Left, PathScripts.PathDressupDogbone.Side.Left, PathScripts.PathGeom.Side.Left, Gui::Camera.Right, PathScripts.PathDressupDogbone.Side.Right, and PathScripts.PathGeom.Side.Right.

Member Data Documentation

Left

int PathScripts.PathGeom.Side.Left = +1

static

Referenced by PathScripts.PathGeom.Side.of(), PathScripts.PathDressupDogbone.Side.oppositeOf(), and PathScripts.PathGeom.Side.toString().

On

int PathScripts.PathGeom.Side.On = 0

static

Right

int PathScripts.PathGeom.Side.Right = -1

static

Referenced by PathScripts.PathGeom.Side.of(), PathScripts.PathDressupDogbone.Side.oppositeOf(), and PathScripts.PathGeom.Side.toString().

Straight

int PathScripts.PathGeom.Side.Straight = 0

static

Referenced by PathScripts.PathGeom.Side.of().

---

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

• FreeCAD/src/Mod/Path/PathScripts/PathGeom.py