Skip to content

Point_API.md

Latest commit

 

History

History
203 lines (75 loc) · 4.14 KB

Point_API.md

File metadata and controls

203 lines (75 loc) · 4.14 KB
Raw

Point API

Describes a point To create a point there are several ways: Part.Point() Creates a default point

Part.Point(Point) Creates a copy of the given point

Part.Point(Vector) Creates a line for the given coordinates

Content

Content of the object in XML representation.

MemSize

Memory size of the object in bytes.

Module

Module in which this class is defined

Tag

Gives the tag of the geometry as string.

TypeId

Is the type of the FreeCAD object with module domain

X

X component of this point.

Y

Y component of this point.

Z

Z component of this point.

clone

Create a clone of this geometry with the same Tag

copy

Create a copy of this geometry

deleteExtensionOfName

Deletes all extensions of the indicated name.

deleteExtensionOfType

Deletes all extensions of the indicated type.

dumpContent

dumpContent(Compression=3) -> bytearray

Dumps the content of the object, both the XML representation and the additional data files required, into a byte representation.

Compression : int Set the data compression level in the range [0,9]. Set to 0 for no compression.

getAllDerivedFrom

Returns all descendants

getExtensionOfName

Gets the first geometry extension of the name indicated by the string.

getExtensionOfType

Gets the first geometry extension of the type indicated by the string.

getExtensions

Returns a list with information about the geometry extensions.

hasExtensionOfName

Returns a boolean indicating whether a geometry extension with the name indicated as a string exists.

hasExtensionOfType

Returns a boolean indicating whether a geometry extension of the type indicated as a string exists.

isDerivedFrom

Returns true if given type is a father

mirror

Performs the symmetrical transformation of this geometric object

restoreContent

restoreContent(obj) -> None

Restore the content of the object from a byte representation as stored by dumpContent. It could be restored from any Python object implementing the buffer protocol.

obj : buffer Object with buffer protocol support.

rotate

Rotates this geometric object at angle Ang (in radians) about axis

scale

Applies a scaling transformation on this geometric object with a center and scaling factor

setExtension

Sets a geometry extension of the indicated type.

toShape

Create a vertex from this point.

transform

Applies a transformation to this geometric object

translate

Translates this geometric object

documentation index > API > Point API