Skip to content

# `flShape`

## fontlab.flShape = class flShape(object)

      flShape representation

      Constructors:
        flShape()
        flShape(flObject)
        flShape(flShapeData)
        flShape(flSticker)
        flShape(QImage)
        flShape(fgShape)
        flShape(flShapeBuilder)

#### Methods

__delattr__(...)

      x.__delattr__('name') <==> del x.name

__eq__(...)

      x.__eq__(y) <==> x==y

__ge__(...)

      x.__ge__(y) <==> x>=y

__getattribute__(...)

      x.__getattribute__('name') <==> x.name

__gt__(...)

      x.__gt__(y) <==> x>y

__init__(...)

      x.__init__(...) initializes x; see help(type(x)) for signature

__le__(...)

      x.__le__(y) <==> x<=y

__lt__(...)

      x.__lt__(y) <==> x

__ne__(...)

      x.__ne__(y) <==> x!=y

__repr__(...)

      x.__repr__() <==> repr(x)

__setattr__(...)

      x.__setattr__('name', value) <==> x.name = value

activateBuilder(...)

      activateBuilder()

addContour(...)

      addContour(flContour)

addContours(...)

      addContours(list(flContour))

appendAnchor(...)

      appendAnchor(flAnchor) | void appendAnchor(flNode node, flObject guideline)

applyTransform(...)

      applyTransform([QTransform transform])

assign(...)

      assign(fgShape)

assignStyle(...)

      assignStyle(flShape)

bindDependencies(...)

      bindDependencies()

canUngroup(...)

      bool canUngroup()

changed(...)

      changed()

checkInitHistoryState(...)

      checkInitHistoryState(uint history_ix)

clearAboveHistory(...)

      clearAboveHistory(uint history_ix)

clearContours(...)

      clearContours()

clearFlag(...)

      clearFlag(uint f)

clearFlags(...)

      clearFlags()

clone(...)

      Clone the object

cloneTopLevel(...)

      flShape cloneTopLevel()

contains(...)

      bool contains(QPointF)

containsInInclude(...)

      bool containsInInclude(flShape | uint id)

convertToFgShape(...)

      convertToFgShape(fgShape)

copyToFgShape(...)

      copyToFgShape(fgShape)

createHistoryState(...)

      createHistoryState(uint history_ix)

currentHistoryState(...)

      currentHistoryIx()

cutContour(...)

      (list(flContour) inner, list(flContour) outer)/Nothing cutContour(flContour, QTransform)

decomposite(...)

      decomposite()

eject(...)

      eject(flShape)

ejectTo(...)

      list(flShape) ejectTo([bool clone =true[, bool apply_tx =true]])

ensurePaths(...)

      ensurePaths()

findNode(...)

      flNode findNode(QString)

flag(...)

      flag(uint f)

getActiveComposite(...)

      flShape/Nothing getActiveComposite()

getActiveIncludeShape(...)

      flShape/Nothing getActiveIncludeShape()

getAnchorForObject(...)

      flAnchor/Nothing getAnchorForObject(flObject)

getAnchors(...)

      list(flAnchor)/Nothing getAnchors()

getCompositesBounding(...)

      QRectF getCompositesBounding()

getContours(...)

      list(flContour) getContours()

getNodeAt(...)

      flNode/Nothing getNodeAt(int index, flNode::NodeType nodetype)

getProperties(...)

      Get object's properties list

getProperty(...)

      getProperty('key') - get object property by 'key' or number

getPropertyFloat(...)

      getPropertyFloat('key') - get float object property by 'key'

getPropertyInt(...)

      getPropertyInt('key') - get int object property by 'key'

getSelected(...)

      list(flContour)/Nothing getSelected(SelectionMode)

getSquare(...)

      double getSquare()

getTransformationPermissions(...)

      (bool enbl_horz, bool enbl_vert, bool enbl_rotation) getTransformationPermissions()

hasHistoryState(...)

      hasHistoryState(uint history_ix)

hasImage(...)

      bool hasImage(bool bitmap_only)

hasSelected(...)

      bool hasSelected(SelectionMode)

historyStates(...)

      historyStates(bool accepted_state)

horzReflection(...)

      bool horzReflection()

include(...)

      include(list(flShape) | flShape, [ flLayer remove_from])

includeTo(...)

      includeTo(int ix, flShape)

independedAll(...)

      independedAll()

initialHistoryState(...)

      initialHistoryIx()

inkBox(...)

      QRectF inkBox([QTransform tx = QTransform()])

isCompatible(...)

      bool isCompatible(flShape, bool strong)

isEqual(...)

      isEqual(flObject)

mergeTopComposite(...)

      mergeTopComposite()

prepareTransformationData(...)

      prepareTransformationData()

release(...)

      release()

remove(...)

      remove([flObject])

removeAnchor(...)

      removeAnchor(flAnchor)

removeAnchorsForObject(...)

      removeAnchorsForObject(flObject)

removeBackContour(...)

      removeBackContour()

removeChild(...)

      removeChild(flObject)

removeContour(...)

      removeContour(flContour)

removeContours(...)

      removeContours(list(flContour))

removeProperty(...)

      removeProperty('key')

replaceInclude(...)

      replaceInclude(flShape old_shape, flShape new_shape)

resetInkBox(...)

      resetInkBox()

resetTransformationData(...)

      resetTransformationData()

restoreHistoryState(...)

      restoreHistoryState(uint history_ix)

selectAllData(...)

      selectAllData()

setFlag(...)

      setFlag(uint f [, bool value])

setIncludes(...)

      setIncludes(list(flShape))

setProperty(...)

      setProperty('key', value) - set object property by 'key' or number

setPropertyFloat(...)

      setPropertyFloat('key', value) - set float object property by 'key'

setPropertyInt(...)

      setPropertyInt('key', value) - set int object property by 'key'

setReflected(...)

      setReflected(bool, bool)

simpleShape(...)

      bool simpleShape()

tag(...)

      tag([string])

unselectAllNodes(...)

      unselectAllNodes()

update(...)

      update()

vertReflection(...)

      bool vertReflection()

#### Static methods

cloneObject(...)

      flObject cloneObject(const flObject&);

createInstance(...)

      flShape createInstance()

createObject(...)

      flObject/Nothing createObject(int);

haveObject(...)

      bool haveObject(uint);

instanceType(...)

      int instanceType();

isShape(...)

      bool isShape(flObject)

#### Descriptors

active

      bool

allSelectedData

      bool

boundingBox

      QRectF

brush

      QBrush

closedPath

      QPainterPath

contentLocked

      bool

contours

      list(flContour)

contoursCount

      int

excluded

      bool

fl_transform

      flTransform

hasBody

      bool

hasChanges

      bool

hasComponents

      bool

hasContours

      bool

hasGlobalAnchoring

      bool

hasHistoryStates

      bool

hasPath

      bool

hasSmartAngle

      bool

haveActiveShape

      bool

haveClosed

      bool

haveData

      bool

haveUnclosed

      bool

id

      object id

image

      QImage

imagePtr

      QImage *

includesList

      list(flShape)

isChanged

      bool

isComponent

      bool

isComposite

      bool

isEmpty

      bool

isNull

      bool

isPresent

      bool

isReleased

      bool

isUnbindedDependencies

      bool

isUniform

      bool

isValid

      bool

name

      object name

opacity

      double

openedPath

      QPainterPath

pen

      QPen

refCnt

      object references count

selected

      bool

shapeBuilder

      flShapeBuilder

shapeData

      flShapeData

shapeType

      ShapeType

sticker

      flSticker

transform

      transform

type

      object type

#### Attributes

__new__ = <built-in method __new__ of type object>

      T.__new__(S, ...) -> a new object with type S, a subtype of T

flObjectFlags = {'ofAnchored': 64, 'ofChanged': 2, 'ofHistory': 128, 'ofIgnore': 8, 'ofIgnoreChanges': 4, 'ofPassive': 16, 'ofReleased': 1, 'ofSlowUpdate': 32}

## `activateBuilder`

fontlab.flShape.activateBuilder = activateBuilder(...)

      activateBuilder()

## `active`

fontlab.flShape.active

      bool

## `addContour`

fontlab.flShape.addContour = addContour(...)

      addContour(flContour)

## `addContours`

fontlab.flShape.addContours = addContours(...)

      addContours(list(flContour))

## `allSelectedData`

fontlab.flShape.allSelectedData

      bool

## `appendAnchor`

fontlab.flShape.appendAnchor = appendAnchor(...)

      appendAnchor(flAnchor) | void appendAnchor(flNode node, flObject guideline)

## `applyTransform`

fontlab.flShape.applyTransform = applyTransform(...)

      applyTransform([QTransform transform])

## `assign`

fontlab.flShape.assign = assign(...)

      assign(fgShape)

## `assignStyle`

fontlab.flShape.assignStyle = assignStyle(...)

      assignStyle(flShape)

## `bindDependencies`

fontlab.flShape.bindDependencies = bindDependencies(...)

      bindDependencies()

## `boundingBox`

fontlab.flShape.boundingBox

      QRectF

## `brush`

fontlab.flShape.brush

      QBrush

## `canUngroup`

fontlab.flShape.canUngroup = canUngroup(...)

      bool canUngroup()

## `changed`

fontlab.flShape.changed = changed(...)

      changed()

## `checkInitHistoryState`

fontlab.flShape.checkInitHistoryState = checkInitHistoryState(...)

      checkInitHistoryState(uint history_ix)

## `clearAboveHistory`

fontlab.flShape.clearAboveHistory = clearAboveHistory(...)

      clearAboveHistory(uint history_ix)

## `clearContours`

fontlab.flShape.clearContours = clearContours(...)

      clearContours()

## `clearFlag`

fontlab.flShape.clearFlag = clearFlag(...)

      clearFlag(uint f)

## `clearFlags`

fontlab.flShape.clearFlags = clearFlags(...)

      clearFlags()

## `clone`

fontlab.flShape.clone = clone(...)

      Clone the object

## `cloneObject`

fontlab.flShape.cloneObject = cloneObject(...)

      flObject cloneObject(const flObject&);

## `cloneTopLevel`

fontlab.flShape.cloneTopLevel = cloneTopLevel(...)

      flShape cloneTopLevel()

## `closedPath`

fontlab.flShape.closedPath

      QPainterPath

## `contains`

fontlab.flShape.contains = contains(...)

      bool contains(QPointF)

## `containsInInclude`

fontlab.flShape.containsInInclude = containsInInclude(...)

      bool containsInInclude(flShape | uint id)

## `contentLocked`

fontlab.flShape.contentLocked

      bool

## `contours`

fontlab.flShape.contours

      list(flContour)

## `contoursCount`

fontlab.flShape.contoursCount

      int

## `convertToFgShape`

fontlab.flShape.convertToFgShape = convertToFgShape(...)

      convertToFgShape(fgShape)

## `copyToFgShape`

fontlab.flShape.copyToFgShape = copyToFgShape(...)

      copyToFgShape(fgShape)

## `createHistoryState`

fontlab.flShape.createHistoryState = createHistoryState(...)

      createHistoryState(uint history_ix)

## `createInstance`

fontlab.flShape.createInstance = createInstance(...)

      flShape createInstance()

## `createObject`

fontlab.flShape.createObject = createObject(...)

      flObject/Nothing createObject(int);

## `currentHistoryState`

fontlab.flShape.currentHistoryState = currentHistoryState(...)

      currentHistoryIx()

## `cutContour`

fontlab.flShape.cutContour = cutContour(...)

      (list(flContour) inner, list(flContour) outer)/Nothing cutContour(flContour, QTransform)

## `decomposite`

fontlab.flShape.decomposite = decomposite(...)

      decomposite()

## `eject`

fontlab.flShape.eject = eject(...)

      eject(flShape)

## `ejectTo`

fontlab.flShape.ejectTo = ejectTo(...)

      list(flShape) ejectTo([bool clone =true[, bool apply_tx =true]])

## `ensurePaths`

fontlab.flShape.ensurePaths = ensurePaths(...)

      ensurePaths()

## `excluded`

fontlab.flShape.excluded

      bool

## `findNode`

fontlab.flShape.findNode = findNode(...)

      flNode findNode(QString)

## `fl_transform`

fontlab.flShape.fl_transform

      flTransform

## `flag`

fontlab.flShape.flag = flag(...)

      flag(uint f)

## `flObjectFlags`

fontlab.flShape.flObjectFlags = {'ofAnchored': 64, 'ofChanged': 2, 'ofHistory': 128, 'ofIgnore': 8, 'ofIgnoreChanges': 4, 'ofPassive': 16, 'ofReleased': 1, 'ofSlowUpdate': 32}

## `getActiveComposite`

fontlab.flShape.getActiveComposite = getActiveComposite(...)

      flShape/Nothing getActiveComposite()

## `getActiveIncludeShape`

fontlab.flShape.getActiveIncludeShape = getActiveIncludeShape(...)

      flShape/Nothing getActiveIncludeShape()

## `getAnchorForObject`

fontlab.flShape.getAnchorForObject = getAnchorForObject(...)

      flAnchor/Nothing getAnchorForObject(flObject)

## `getAnchors`

fontlab.flShape.getAnchors = getAnchors(...)

      list(flAnchor)/Nothing getAnchors()

## `getCompositesBounding`

fontlab.flShape.getCompositesBounding = getCompositesBounding(...)

      QRectF getCompositesBounding()

## `getContours`

fontlab.flShape.getContours = getContours(...)

      list(flContour) getContours()

## `getNodeAt`

fontlab.flShape.getNodeAt = getNodeAt(...)

      flNode/Nothing getNodeAt(int index, flNode::NodeType nodetype)

## `getProperties`

fontlab.flShape.getProperties = getProperties(...)

      Get object's properties list

## `getProperty`

fontlab.flShape.getProperty = getProperty(...)

      getProperty('key') - get object property by 'key' or number

## `getPropertyFloat`

fontlab.flShape.getPropertyFloat = getPropertyFloat(...)

      getPropertyFloat('key') - get float object property by 'key'

## `getPropertyInt`

fontlab.flShape.getPropertyInt = getPropertyInt(...)

      getPropertyInt('key') - get int object property by 'key'

## `getSelected`

fontlab.flShape.getSelected = getSelected(...)

      list(flContour)/Nothing getSelected(SelectionMode)

## `getSquare`

fontlab.flShape.getSquare = getSquare(...)

      double getSquare()

## `getTransformationPermissions`

fontlab.flShape.getTransformationPermissions = getTransformationPermissions(...)

      (bool enbl_horz, bool enbl_vert, bool enbl_rotation) getTransformationPermissions()

## `hasBody`

fontlab.flShape.hasBody

      bool

## `hasChanges`

fontlab.flShape.hasChanges

      bool

## `hasComponents`

fontlab.flShape.hasComponents

      bool

## `hasContours`

fontlab.flShape.hasContours

      bool

## `hasGlobalAnchoring`

fontlab.flShape.hasGlobalAnchoring

      bool

## `hasHistoryState`

fontlab.flShape.hasHistoryState = hasHistoryState(...)

      hasHistoryState(uint history_ix)

## `hasHistoryStates`

fontlab.flShape.hasHistoryStates

      bool

## `hasImage`

fontlab.flShape.hasImage = hasImage(...)

      bool hasImage(bool bitmap_only)

## `hasPath`

fontlab.flShape.hasPath

      bool

## `hasSelected`

fontlab.flShape.hasSelected = hasSelected(...)

      bool hasSelected(SelectionMode)

## `hasSmartAngle`

fontlab.flShape.hasSmartAngle

      bool

## `haveActiveShape`

fontlab.flShape.haveActiveShape

      bool

## `haveClosed`

fontlab.flShape.haveClosed

      bool

## `haveData`

fontlab.flShape.haveData

      bool

## `haveObject`

fontlab.flShape.haveObject = haveObject(...)

      bool haveObject(uint);

## `haveUnclosed`

fontlab.flShape.haveUnclosed

      bool

## `historyStates`

fontlab.flShape.historyStates = historyStates(...)

      historyStates(bool accepted_state)

## `horzReflection`

fontlab.flShape.horzReflection = horzReflection(...)

      bool horzReflection()

## `id`

fontlab.flShape.id

      object id

## `image`

fontlab.flShape.image

      QImage

## `imagePtr`

fontlab.flShape.imagePtr

      QImage *

## `include`

fontlab.flShape.include = include(...)

      include(list(flShape) | flShape, [ flLayer remove_from])

## `includesList`

fontlab.flShape.includesList

      list(flShape)

## `includeTo`

fontlab.flShape.includeTo = includeTo(...)

      includeTo(int ix, flShape)

## `independedAll`

fontlab.flShape.independedAll = independedAll(...)

      independedAll()

## `initialHistoryState`

fontlab.flShape.initialHistoryState = initialHistoryState(...)

      initialHistoryIx()

## `inkBox`

fontlab.flShape.inkBox = inkBox(...)

      QRectF inkBox([QTransform tx = QTransform()])

## `instanceType`

fontlab.flShape.instanceType = instanceType(...)

      int instanceType();

## `isChanged`

fontlab.flShape.isChanged

      bool

## `isCompatible`

fontlab.flShape.isCompatible = isCompatible(...)

      bool isCompatible(flShape, bool strong)

## `isComponent`

fontlab.flShape.isComponent

      bool

## `isComposite`

fontlab.flShape.isComposite

      bool

## `isEmpty`

fontlab.flShape.isEmpty

      bool

## `isEqual`

fontlab.flShape.isEqual = isEqual(...)

      isEqual(flObject)

## `isNull`

fontlab.flShape.isNull

      bool

## `isPresent`

fontlab.flShape.isPresent

      bool

## `isReleased`

fontlab.flShape.isReleased

      bool

## `isShape`

fontlab.flShape.isShape = isShape(...)

      bool isShape(flObject)

## `isUnbindedDependencies`

fontlab.flShape.isUnbindedDependencies

      bool

## `isUniform`

fontlab.flShape.isUniform

      bool

## `isValid`

fontlab.flShape.isValid

      bool

## `mergeTopComposite`

fontlab.flShape.mergeTopComposite = mergeTopComposite(...)

      mergeTopComposite()

## `name`

fontlab.flShape.name

      object name

## `opacity`

fontlab.flShape.opacity

      double

## `openedPath`

fontlab.flShape.openedPath

      QPainterPath

## `pen`

fontlab.flShape.pen

      QPen

## `prepareTransformationData`

fontlab.flShape.prepareTransformationData = prepareTransformationData(...)

      prepareTransformationData()

## `refCnt`

fontlab.flShape.refCnt

      object references count

## `release`

fontlab.flShape.release = release(...)

      release()

## `remove`

fontlab.flShape.remove = remove(...)

      remove([flObject])

## `removeAnchor`

fontlab.flShape.removeAnchor = removeAnchor(...)

      removeAnchor(flAnchor)

## `removeAnchorsForObject`

fontlab.flShape.removeAnchorsForObject = removeAnchorsForObject(...)

      removeAnchorsForObject(flObject)

## `removeBackContour`

fontlab.flShape.removeBackContour = removeBackContour(...)

      removeBackContour()

## `removeChild`

fontlab.flShape.removeChild = removeChild(...)

      removeChild(flObject)

## `removeContour`

fontlab.flShape.removeContour = removeContour(...)

      removeContour(flContour)

## `removeContours`

fontlab.flShape.removeContours = removeContours(...)

      removeContours(list(flContour))

## `removeProperty`

fontlab.flShape.removeProperty = removeProperty(...)

      removeProperty('key')

## `replaceInclude`

fontlab.flShape.replaceInclude = replaceInclude(...)

      replaceInclude(flShape old_shape, flShape new_shape)

## `resetInkBox`

fontlab.flShape.resetInkBox = resetInkBox(...)

      resetInkBox()

## `resetTransformationData`

fontlab.flShape.resetTransformationData = resetTransformationData(...)

      resetTransformationData()

## `restoreHistoryState`

fontlab.flShape.restoreHistoryState = restoreHistoryState(...)

      restoreHistoryState(uint history_ix)

## `selectAllData`

fontlab.flShape.selectAllData = selectAllData(...)

      selectAllData()

## `selected`

fontlab.flShape.selected

      bool

## `setFlag`

fontlab.flShape.setFlag = setFlag(...)

      setFlag(uint f [, bool value])

## `setIncludes`

fontlab.flShape.setIncludes = setIncludes(...)

      setIncludes(list(flShape))

## `setProperty`

fontlab.flShape.setProperty = setProperty(...)

      setProperty('key', value) - set object property by 'key' or number

## `setPropertyFloat`

fontlab.flShape.setPropertyFloat = setPropertyFloat(...)

      setPropertyFloat('key', value) - set float object property by 'key'

## `setPropertyInt`

fontlab.flShape.setPropertyInt = setPropertyInt(...)

      setPropertyInt('key', value) - set int object property by 'key'

## `setReflected`

fontlab.flShape.setReflected = setReflected(...)

      setReflected(bool, bool)

## `shapeBuilder`

fontlab.flShape.shapeBuilder

      flShapeBuilder

## `shapeData`

fontlab.flShape.shapeData

      flShapeData

## `shapeType`

fontlab.flShape.shapeType

      ShapeType

## `simpleShape`

fontlab.flShape.simpleShape = simpleShape(...)

      bool simpleShape()

## `sticker`

fontlab.flShape.sticker

      flSticker

## `tag`

fontlab.flShape.tag = tag(...)

      tag([string])

## `transform`

fontlab.flShape.transform

      transform

## `type`

fontlab.flShape.type

      object type

## `unselectAllNodes`

fontlab.flShape.unselectAllNodes = unselectAllNodes(...)

      unselectAllNodes()

## `update`

fontlab.flShape.update = update(...)

      update()

## `vertReflection`

fontlab.flShape.vertReflection = vertReflection(...)

      bool vertReflection()