TopoShape API

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page TopoShape API and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎română
(novembre 2018) Ces informations peuvent être incomplètes et obsolètes. Pour la dernière API, consultez la documentation de l'API générée automatiquement.


L'objet TopoShape est l'objet principal du Module Part. Tous les types de formes (fil, face, solide, etc...) du module part sont des TopoShapes, et, partagent les attributs, et, méthodes suivantes.

import Part
sh = Part.makeBox(10,10,10)
print sh.Faces
for f in sh.Faces:
   print f.Edges
Property.png Area

Retourne: La superficie totale des faces de la forme.


Property.png CompSolids

Retourne: Répertorie les formes ultérieures dans cette forme.


Property.png CenterOfMass

Retourne: Donne le centre de la masse de la forme actuelle. Si le champ de gravitation est uniforme, c'est le centre de gravité. Les coordonnées retournées pour le centre de masse sont exprimées dans le système de coordonnées cartésiennes absolu.


Property.png Compounds

Retourne: Répertorie les composantes de cette forme.


Property.png Edges

Retourne: Répertorie les contours de cette forme.


Property.png Faces

Retourne: Répertorie les visages de cette forme.


Property.png Length

Retourne: Longueur totale des bords de la forme.


Property.png Orientation

Retourne: l'orientation de la forme.


Property.png ShapeType

Retourne: Le type de la forme.


Property.png Shells

Retourne: Répertorie les formes ultérieures dans cette forme.


Property.png Solids

Retourne: Liste des formes ultérieures dans cette forme.


Property.png Vertexes

Retourne: Liste des sommets de cette forme.


Property.png Volume

Retourne: Volume total des solides de la forme.


Property.png Wires

Retourne: Liste des fils de cette forme.


Property.png BoundBox

Retourne: Les dimensions hors tout de l'objet


Property.png Matrix

Retourne: Donne une matrice de la transformation actuelle de l'objet


Property.png Placement

Retourne: Donne la transformation actuelle de l'objet comme placement


Method.png approximate ( )

Description : Se rapproche d'une courbe B-Spline

Retourne : a BSplineCurve object

Method.png check ( )

Description : Vérifie les erreurs de forme et les rapporte dans la structure de la forme. Il s'agit d'une vérification plus détaillée comme cela se fait dans isValid().

Retourne :

Method.png common ( TopoShape )

Description : Intersection de la forme et une forme donnée.

Retourne : un TopoShape

Method.png complement ( )

Description : Calcule le complément de l'orientation de cette forme, c'est-à-dire inverse l'état intérieur/extérieur des limites de cette forme.

Retourne : un TopoShape

Method.png copy ( )

Description : Crée une copie de cette forme

Retourne : un TopoShape

Method.png cut ( TopoShape )

Description : Différence entre la forme et une forme donnée.

Retourne : un TopoShape

Method.png distToShape ( TopoShape )

Description : Calcule la distance minimale entre ceci et une donnée TopoShape.

Retourne : float <distance minimum>, list < le point le plus proche >, list < la forme secondaire la plus proche & ces paramètres >

Method.png exportBrep ( string )

Description : Exporte le contenu de cette la forme dans un fichier BREP. BREP est le format natif de CasCade.

Retourne :

Method.png exportIges ( string )

Description : Exporte le contenu de la forme dans un fichier IGES.

Retourne :

Method.png exportStep ( string )

Description : Exporte le contenu de la forme dans un fichier STEP.

Retourne :

Method.png exportStl ( string )

Description : Exporte le contenu de la forme dans un fichier de maillage STL.

Retourne :

Method.png extrude ( Vector )

Description : Extrude la forme le long d'une direction.

Retourne : un TopoShape

Method.png fuse ( TopoShape )

Description : Union de la forme et une forme donnée.

Retourne : un TopoShape

Method.png getAllDerivedFrom ( )

Description : Retourne toute la descendance de ce type d'objet

Retourne : une liste

Method.png hashCode ( )

Description : Cette valeur est calculée à partir de la valeur de la référence sous-jacente de la forme et l'emplacement. L'orientation n'est pas prise en compte.

Retourne : a string

Method.png isClosed ( )

Description : Vérifie si la forme est fermée.

Retourne : un booléen

Method.png isDerivedFrom ( string )

Description : Retourne la valeur true si le type donné est le père (maître)

Retourne : boolean

Method.png isEqual ( TopoShape )

Description : Retourne true si les deux formes partagent le même TShape, ont le même emplacement et ont la même orientation.

Retourne : un booléen

Method.png isInside ( Vector,float,Boolean )

Description : Vérifie si un point est à l'intérieur d'un solide, avec une certaine tolérance. Si le troisième paramètre est true un point sur une face est considéré comme inside

Retourne : un booléen

Method.png isNull ( )

Description : Vérifie si la forme est nulle.

Retourne : un booléen

Method.png isPartner ( TopoShape )

Description : Renvoie true si les deux formes partagent le même TShape, mais peut avoir un emplacement différent et avoir une orientation différente.

Retourne : un booléen

Method.png isSame ( TopoShape )

Description : Vérifie si les deux formes partagent la même géométrie, donne true si les deux formes partagent le même TShape, elles ont le même emplacement mais peuvent avoir une orientation différente.

Retourne : un booléen

Method.png isValid ( )

Description : Vérifie si la forme est valide, c'est à dire ni nulle, ni vide ni endommagée.

Retourne : un booléen

Method.png makeFillet ( float,TopoShape )

Description : Retourne un nouvel objet basé sur un TopoShape, mais avec un rayon de courbure "float" appliqué à chaque arête.

Retourne : un TopoShape

Method.png makeHomogenousWires ( wire )

Description : Construit un fil homogène avec le même nombre d'arêtes

Retourne : a wire

Method.png makeOffset ( float )

Description : Décale la forme selon une distance donnée

Retourne : un TopoShape

Method.png makePipe ( wire )

Description : Fait un tube en suivant une ligne.

Retourne : un TopoShape

Method.png makePipeShell ( wire )

Description : Rend un loft défini par son profil le long d'une ligne.

Retourne : un TopoShape

Method.png makeShapeFromMesh ( mesh )

Description : Fait une forme composée de données de maillage. Remarque : Cela devrait être utilisé plutôt pour de petites mailles.

Retourne : un TopoShape

Method.png makeThickness ( list,float,float )

Description : Un solide évidé est construit à partir d'un solide initial, et, un ensemble de faces sur ce solide, qui doivent être éliminés. Les faces restantes du solide deviennent les murs du solide évidé, leur épaisseur est définie au moment de la construction. Les arguments à transmettre sont une liste des faces à ignorer, l'épaisseur des murs, et, une valeur de tolérance.

Retourne : un TopoShape

Method.png nullify ( )

Description : Détruit la référence à la forme sous-jacente stockée sous cette forme. En conséquence, cette forme devient nulle.

Retourne :

Method.png project ( TopoShape )

Description : Projete une forme sur votre forme

Retourne : un TopoShape

Method.png read ( string )

Description : Lit un fichier IGES, STEP ou BREP.

Retourne : un TopoShape

Method.png reverse ( )

Description : Inverse l'orientation de cette forme.

Retourne :

Method.png revolve ( Vector, Vector, float )

Description : S'articule autour d'un axe à un degré donné. ex : Part.revolve(Vector(0,0,0),Vector(0,0,1),360) tourne la forme autour d'un axe Z de 360 degrés.

Retourne : un TopoShape

Method.png rotate ( Vector, Vector, float )

Description : Applique la rotation (en degré) à l'emplacement actuel de cette forme. ex : Shp.rotate(Vector(0,0,0),Vector(0,0,1),180) fait pivoter la forme autour de l'axe Z de 180 degrés.

Retourne : un TopoShape

Method.png scale ( )

Description : S'applique à l'échelle avec le point et le facteur de cette forme.

Retourne : un TopoShape

Method.png section ( TopoShape )

Description : Section de la forme avec une forme toposhape.

Retourne : un TopoShape

Method.png sewShape ( )

Description : La machine raccorde la forme s'il y a un écart.

Retourne :

Method.png tessellate ( float )

Description : Tessellate (Paver) la forme et retourne une liste des sommets et indices de la faces. Le float donnée est la tolérance.

Retourne : a list

Method.png toNurbs ( )

Description : Transformation de la géométrie complète d'une forme en géométrie NURBS. Par exemple, toutes les courbes soutenant les bords de la forme de base, sont convertis en courbes de BSP, et toutes les surfaces soutenant ses faces sont converties en surfaces de BSP.

Retourne : a NURBS curve

Method.png transformGeometry ( matrix )

Description : Applique la transformation géométrique sur une copie de la forme. La transformation à appliquer, est définie comme une matrice 4x4. La géométrie sous-jacente des formes suivantes peuvent être changées en courbes qui prennent en charge les extrémités de la forme, ou une surface qui prend en charge une face de la forme. Par exemple, un cercle peut être transformé en une ellipse lorsque vous appliquez une transformation d'affinité. Il peut également arriver que le cercle est alors représenté comme une courbe b-spline. La transformation s'applique à toutes les courbes qui supportent les bords de la forme et toutes les surfaces qui prennent en charge les faces de la forme. Remarque : Si vous voulez transformer une forme sans changer la géométrie sous-jacente, puis utilisez les méthodes traduites ou les faire pivoter.

Retourne : un TopoShape

Method.png transformShape ( matrix )

Description : Applique la transformation d'une forme sans changer la géométrie sous-jacente.

Retourne :

Method.png translate ( Vector )

Description : Applique la conversion à l'emplacement actuel de cette forme.

Retourne :

Method.png writeInventor ( )

Description : Écrit le maillage au format OpenInventor dans une chaîne.

Retourne : a string


Certains attributs et méthodes s'appliquent uniquement à certains TopoShapes.

Ces points s'appliquent aux bords (TopoShapeEdge).


Property.png FirstParameter

Retourne: La valeur du paramètre du bord à une extrémité. Pas nécessairement le Vertex[0]. Voir équations paramétriques


Property.png LastParameter

Retourne: La valeur du paramètre du bord à l'autre extrémité. Pas nécessairement le Vertex[1].



Method.png centerOfCurvatureAt ( Float )

Description : Retourne le centre (points 3D) ou la valeur des paramètres du cercle.

Retourne : Vector

Method.png curvatureAt ( Float )

Description : Retourne la valeur des paramètres de la courbe du bord.

Retourne : Float

Method.png getParameterByLength ( Float )

Description : Retourne l’intervalle [0,Length] jusqu'au prochain intervalle [Premier Paramètre,dernier Paramètre]

Retourne : Float

Method.png normalAt ( Float )

Description : Retourne la valeur des paramètres de la normale du bord (uniquement s'il existe).

Retourne : Vector

Method.png parameterAt ( Vertex,[Face] )

Description : Retourne la valeur correspondante au Vertex (points 3D).

Retourne : Float

Method.png tangentAt ( Float )

Description : Retourne la valeur des paramètres de la direction du vecteur de la tangente du bord (s'il existe).

Retourne : Vector

Method.png valueAt ( Float )

Description : Retourne la valeur du vecteur correspondant au paramètre 3D.

Retourne : Vector