Commands Namespace Reference

Classes
class	CommandAdd
class	CommandMeshToShape
class	CommandRemove
class	CommandRemoveShape
class	CommandSelectNonSolidMeshes
class	CommandSplitMesh
class	SphereCreator
class	TemplatePyMod_Cmd1
class	TemplatePyMod_Cmd2
class	TemplatePyMod_Cmd3
class	TemplatePyMod_Cmd4
class	TemplatePyMod_Cmd5
class	TemplatePyMod_Cmd6
Functions
def	addCommand
def	addComponents
def	meshToShape
def	removeComponents
def	removeShape
def	splitMesh
Variables
string	__author__ = "Yorik van Havre"
string	__title__ = "FreeCAD Arch Commands"
string	__url__ = "http://free-cad.sourceforge.net"
	myRenderArea = None

---

Function Documentation

def Commands::addCommand	(		name,
			cmdObject
	)

Definition at line 12 of file TemplatePyMod/Commands.py.

def Commands::addComponents	(		objectsList,
			host
	)

addComponents(objectsList,hostObject): adds the given object or the objects
from the given list as components to the given host Object. Use this for
example to add windows to a wall, or to add walls to a cell or floor.

Definition at line 35 of file Arch/Commands.py.

def Commands::meshToShape	(		obj,
			mark = True
	)

meshToShape(object,[mark]): turns a mesh into a shape, joining coplanar facets. If
mark is True (default), non-solid objects will be marked in red

Definition at line 125 of file Arch/Commands.py.

def Commands::removeComponents	(		objectsList,
			host = None
	)

removeComponents(objectsList,[hostObject]): removes the given component or
the components from the given list from their parents. If a host object is
specified, this function will try adding the components as holes to the host
object instead.

Definition at line 63 of file Arch/Commands.py.

def Commands::removeShape	(		objs,
			mark = True
	)

takes an arch object (wall or structure) built on a cubic shape, and removes
the inner shape, keeping its length, width and height as parameters.

Definition at line 182 of file Arch/Commands.py.

def Commands::splitMesh	(		obj,
			mark = True
	)

splitMesh(object,[mark]): splits the given mesh object into separated components.
If mark is False, nothing else is done. If True (default), non-manifold components
will be painted in red.

Definition at line 105 of file Arch/Commands.py.

---

Variable Documentation

string Commands::__author__ = "Yorik van Havre"

Definition at line 30 of file Arch/Commands.py.

string Commands::__title__ = "FreeCAD Arch Commands"

Definition at line 29 of file Arch/Commands.py.

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

Definition at line 31 of file Arch/Commands.py.

Commands::myRenderArea = None

Definition at line 155 of file TemplatePyMod/Commands.py.