TopoShape API

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page TopoShape API and the translation is 43% complete.

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎română
(November 2018) This information may be incomplete and outdated. For the latest API, see the autogenerated API documentation.


TopoShape es el objeto madre del módulo de pieza. Todos los tipos de formas (contornos, caras, sólidos, etc.) del módulo de pieza son TopoShapes, y comparten los siguientes atributos y métodos. Ejemplo:

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

Devuelve: El área total de las caras de la forma.


Property.png CompSolids

Devuelve: Lista las formas subsiguientes en esta forma.


Property.png Compounds

Devuelve: Lista los componentes en esta forma.


Property.png Edges

Devuelve: Lista las aristas en esta forma.


Property.png Faces

Devuelve: Lista las caras en esta forma.


Property.png Length

Devuelve: Longitud total de las aristas de la forma.


Property.png Orientation

Devuelve: La orientación de la forma.


Property.png ShapeType

Devuelve: El tipo de la forma.


Property.png Shells

Devuelve: Lista las subsiguientes formas en esta forma.


Property.png Solids

Devuelve: Lista las subsiguientes formas en esta forma.


Property.png Vertexes

Devuelve: Lista los vértices en esta forma.


Property.png Volume

Devuelve: Volumen total de los sólidos de la forma.


Property.png Wires

Devuelve: Lista de contornos en una forma.


Property.png BoundBox

Devuelve: La caja de abarque del objeto


Property.png Matrix

Devuelve: La transformación actual del objeto como una matriz


Property.png Placement

Devuelve: La transformación actual del objeto como una ubicación


Method.png getAllDerivedFrom ( )

Descripción: Devuelve todos los descendientes de este tipo de objeto

Devuelve: Una lista


Method.png isDerivedFrom ( string )

Descripción: Devuelve true si el tipo indicado es un padre

Devuelve: Un booleano


Method.png approximate ( )

Descripción: Aproxima un curva BSpline a partir de su contorno

Devuelve: Un objeto BSplineCurve


Method.png makeHomogenousWires ( wire )

Descripción: Crea este y el contorno dado homogéneos para tener el mismo número de aristas

Devuelve: Un contorno


Method.png makeOffset ( float )

Descripción: Equidista la forma una cantidad dada

Devuelve: Un TopoShape


Property.png CenterOfMass

Devuelve: El centro de masa del sistema actual. Si el campo gravitacional es uniforme, es el centro de gravedad. Las coordenadas devueltas para el centro de masas están expresadas en el sistema de coordenadas cartesiano absoluto.


Method.png check ( )

Descripción: Comprueba la forma e informa de errores en su estructura. Es una comprobación más detallada que en isValid().

Devuelve:


Method.png common ( TopoShape )

Descripción: Intersección de esta y una TopoShape dada.

Devuelve: Una TopoShape


Method.png complement ( )

Descripción: Calcula el complemento de la orientación de esta forma, por ejemplo invierte el estado de los límites exteriores / interiores de esta forma.

Devuelve: Una TopoShape


Method.png copy ( )

Descripción: Crea una copia de la forma

Devuelve: Una TopoShape


Method.png cut ( TopoShape )

Descripción: Resta de esta y la TopoShape dada.

Devuelve: Una TopoShape


Method.png exportBrep ( string )

Descripción: Exporta el contenido de esta forma a un archivo BREP. BREP es un formato nativo de CasCade.

Devuelve:


Method.png exportIges ( string )

Descripción: Exporta el contenido de esta forma a un archivo IGES.

Devuelve:


Method.png exportStep ( string )

Descripción: Exporta el contenido de esta forma a un archivo STEP.

Devuelve:


Method.png exportStl ( string )

Descripción: Exporta el contenido de esta forma a un archivo STL.

Devuelve:


Method.png extrude ( Vector )

Descripción: Extrusiona la forma a lo largo de una dirección.

Devuelve: Una TopoShape


Method.png fuse ( TopoShape )

Descripción: Union de esta y una TopoShape dada.

Devuelve: Una TopoShape


Method.png hashCode ( )

Descripción: Este valor es calculado a partir de la referencia y localización de la forma subyacente. La orientación no se tiene en cuenta.

Devuelve: Una cadena de texto


Method.png isClosed ( )

Descripción: Comprueba si la forma está cerrada.

Devuelve: Un booleano


Method.png isEqual ( TopoShape )

Descripción: Comprueba si ambas formas son iguales.

Devuelve: Un booleano


Method.png isNull ( )

Descripción: Comprueba si la la forma es nula (null).

Devuelve: Un booleano


Method.png isSame ( TopoShape )

Descripción: Comprueba si ambas formas comparten la misma geometría.

Devuelve: Un booleano


Method.png isValid ( )

Descripción: Comprueba si la forma es válida, por ejemplo no nula, no vacía, no corrupta.

Devuelve: Un booleano


Method.png makeFillet ( )

Descripción: Crea redondeo.

Devuelve:


Method.png makePipe ( wire )

Descripción: Crea un tubo barriendo a lo largo de un contorno.

Devuelve: Una TopoShape


Method.png makePipeShell ( wire )

Descripción: Crea un recubrimiento definido por perfiles a lo largo de un contorno.

Devuelve: Una TopoShape


Method.png makeShapeFromMesh ( mesh )

Descripción: Crea una forma compuesta a partir de los datos de la malla. Nota: Esto debería utilizarse sólo para algunas pequeñas mallas.

Devuelve: Una TopoShape


Method.png makeThickness ( list,float,float )

Descripción: Un sólido hueco es construido a partir del sólido inicial mediante un vaciado. El espesor del sólido se define en el momento de la construcción. Los argumentos que son pasados son una lista de caras a ignorar por la operación de vaciado, el espesor de las paredes y un valor de tolerancia.

Devuelve: Una TopoShape


Method.png nullify ( )

Descripción: Destruye la referencia a la forma subyacente almacenada en esta forma. Como resultado, esta forma se convierte en vacía.

Devuelve: {{{4}}}


Method.png project ( TopoShape )

Descripción: Proyecta una forma en esta forma

Devuelve: Una TopoShape


Method.png read ( string )

Descripción: Lee en un archivo IGES, STEP o BREP.

Devuelve: Una TopoShape


Method.png reverse ( )

Descripción: Invierte la orientación de esta forma.

Devuelve:


Method.png revolve ( Vector, Vector, float )

Descripción: Revoluciona la forma alrededor de un eje unos grados dados. Ejemplo: Part.revolve(Vector(0,0,0),Vector(0,0,1),360) revoluciona la forma alrededor del eje Z 360 grados.

Devuelve: Una TopoShape


Method.png rotate ( Vector, Vector, float )

Descripción: Aplica la rotación (grados) a la ubicación actual de esta forma. Ejemplo: Shp.rotate(Vector(0,0,0),Vector(0,0,1),180) rota la forma alrededor del eje Z 180 grados.

Devuelve: Una TopoShape


Method.png scale ( )

Descripción: Aplica un escalado con un punto base y factor de escala a esta forma.

Devuelve: Una TopoShape


Method.png section ( TopoShape )

Descripción: Sección de esta con una TopoShape dada.

Devuelve: Una TopoShape


Method.png sewShape ( )

Descripción: Cose la forma si existe un hueco.

Devuelve:


Method.png tessellate ( float )

Descripción: Tesela la forma y devuelve una lista de índices de vértices y caras. El valor numérico indicado es la tolerancia.

Devuelve: Una lista


Method.png toNurbs ( )

Descripción: Conversión de la geometría completa de una forma en geometría NURBS. Por ejemplo, todas las curvas soportando aristas de formas básicas se convierten en curvas BSpline, y todas las superficies soportando sus caras se convierten en superficies BSpline.

Devuelve: Una curva NURBS


Method.png transformGeometry ( matrix )

Descripción: Aplica transformación geométrica a una copia de la forma. La transformación a ser aplicada se define como una matriz 4x4. La geometría subyacente de las siguientes formas puede cambiar a una curva que soporte una arista de la forma, o una superficie que soporte una cara de la forma. Por ejemplo, una circunferencia puede ser transformada en una elipse cuando se aplica una transformación de afinidad. También puede ocurrir que la circunferencia entonces se represente por una curva Bspline. La transformación es aplicada a todas las curvas que soportan aristas de la forma, y todas las superficies que soportan caras de la forma. Nota: Si quieres transformar una forma sin cambiar la geometría subyacente entonces utiliza el método o rotate.

Devuelve: Una TopoShape


Method.png transformShape ( matrix )

Descripción: Aplica transformación en una forma son cambiar la geometría subyacente.

Devuelve:


Method.png translate ( Vector )

Descripción: Aplica la traslación a la ubicación actual de esta forma.

Devuelve:


Method.png writeInventor ( )

Descripción: Escribe la malla en formato de OpenInventor en una cadena de texto.

Devuelve: Una cadena de texto


Some attributes and methods apply only to certain TopoShapes. These items apply to Edges (TopoShapeEdge).


Property.png FirstParameter

Returns: The parameter value at one end of the Edge. Not necessarily at Vertex[0]. See Parametric Equations

Property.png LastParameter

Returns: The parameter value at the other end of the Edge. Not necessarily at Vertex[1].

Method.png getParameterByLength(Float)

Description: Maps the interval [0,Length] to the interval [FirstParameter,LastParameter]

Returns: Float

Method.png valueAt(Float)

Description: Returns the 3D vector corresponding to a parameter value.

Returns: Vector

Method.png parameterAt(Vertex,[Face])

Description: Returns the parameter value corresponding to a Vertex (3D point).

Returns: Float

Method.png tangentAt(Float)

Description: Returns the direction vector of the tangent to the edge at a parameter value (if it exists).

Returns: Vector

Method.png normalAt(Float)

Description: Returns the direction vector of the normal to the edge at a parameter value (if it exists uniquely).

Returns: Vector

Method.png curvatureAt(Float)

Description: Returns the curvature of the edge at a parameter value.

Returns: Float

Method.png centerOfCurvatureAt(Float)

Description: Returns the center (3D point) of the osculating circle at a parameter value.

Returns: Vector