FreeCAD Python
Classes | Functions
ArchSectionPlane Namespace Reference

Detailed Description

The Section plane object and tools.

This module provides tools to build Section plane objects. It also contains functionality to produce SVG rendering of section planes, to be used in TechDraw and Drawing modules

Classes

class  SectionPlaneTaskPanel
 

Functions

def makeSectionPlane (objectslist=None, name="Section")
 
def makeSectionView (section, name="View")
 
def getSVG (section, renderMode="Wireframe", allOn=False, showHidden=False, scale=1, rotation=0, linewidth=1, lineColor=(0.0, 0.0, 0.0), fontsize=1, showFill=False, fillColor=(0.8, 0.8, 0.8), techdraw=False, fillSpaces=False)
 

Function Documentation

◆ getSVG()

def ArchSectionPlane.getSVG (   section,
  renderMode = "Wireframe",
  allOn = False,
  showHidden = False,
  scale = 1,
  rotation = 0,
  linewidth = 1,
  lineColor = (0.0,0.0,0.0),
  fontsize = 1,
  showFill = False,
  fillColor = (0.8,0.8,0.8),
  techdraw = False,
  fillSpaces = False 
)
getSVG(section, [renderMode, allOn, showHidden, scale, rotation,
          linewidth, lineColor, fontsize, showFill, fillColor, techdraw, fillSpaces]):

returns an SVG fragment from an Arch section plane. If
allOn is True, all cut objects are shown, regardless if they are visible or not.
renderMode can be Wireframe (default) or Solid to use the Arch solid renderer. If
showHidden is True, the hidden geometry above the section plane is shown in dashed line.
If showFill is True, the cut areas get filled with a pattern.
lineColor -- Color of lines for the renderMode "Wireframe".
fillColor -- If showFill is True and renderMode is "Wireframe",
             the cut areas are filled with fillColor.
fillSpaces - If True, shows space objects as filled surfaces

◆ makeSectionPlane()

def ArchSectionPlane.makeSectionPlane (   objectslist = None,
  name = "Section" 
)
makeSectionPlane([objectslist]) : Creates a Section plane objects including the
given objects. If no object is given, the whole document will be considered.

◆ makeSectionView()

def ArchSectionPlane.makeSectionView (   section,
  name = "View" 
)
makeSectionView(section) : Creates a Drawing view of the given Section Plane
in the active Page object (a new page will be created if none exists