BRepFace Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/BRep/BRepFace.h>

Description

Represent a connected region on a single geometric surface.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
convert Creates a new body where this face and its edges are converted to different types of geometry based on the input options.

The tempId on the faces, edges, and vertices on the new body will match with the corresponding tempId on the original body. In cases where the face is split as a result of the conversion there can be more than one face or edge in the new body that matches to a single face or edge in the original body.
createForAssemblyContext Returns a proxy for the native object - i.e. a new object that represents this object but adds the assembly context defined by the input occurrence.
isPointOnFace Checks if input point is on this BRepFace. This takes into account any boundaries so if the point is within a void area of the face, this will return false.

Properties

Name Description
appearance Read-write property that gets and sets the current appearance of the face. Setting this property will result in applying an override appearance to the face and the AppearanceSourceType property will return OverrideAppearanceSource. Setting this property to null will remove any override.
appearanceSourceType Read-write property that gets the source of the appearance for the face. If this returns OverrideAppearanceSource, an override exists on this face. The override can be removed by setting the Appearance property to null.
area Returns the area in cm ^ 2.
assemblyContext Returns the assembly occurrence (i.e. the occurrence) of this object in an assembly. This is only valid in the case where this BRepFace object is acting as a proxy in an assembly. Returns null in the case where the object is not in the context of an assembly. but is already the native object.
attributes Returns the collection of attributes associated with this face.
body Returns the parent body of the face.
boundingBox Returns the bounding box of this face
centroid Returns a point at the centroid (aka, geometric center) of the face.
edges Returns the BRepEdges used by this face
entityToken Returns a token for the BRepFace object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same face.

When using entity tokens it's important to understand that the token string returned for a specific entity can be different over time. However, even if you have two different token strings that were obtained from the same entity, when you use findEntityByToken they will both return the same entity. Because of that you should never compare entity tokens as way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them.

This is only valid for faces that exist in the design, (the isTemporary property is false).
evaluator Returns a SurfaceEvaluator to allow geometric evaluations across the face's surface. This evaluator differs from the evaluator available from the Surface obtained from the geometry property by being bounded by the topological boundaries of this face.
geometry Returns the underlying surface geometry of this face
isParamReversed Gets if the normal of this face is reversed with respect to the surface geometry associated with this face.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
loops Returns the BRepLoops owned by this face
meshManager Returns a MeshManager object that allows access to existing and new meshes of this face.
nativeObject The NativeObject is the object outside the context of an assembly. Returns null in the case where this object is not in the context of an assembly but is already the native object.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
pointOnFace Returns a sample point guaranteed to lie on the face's surface, within the face's boundaries, and not on a boundary edge.
shell Returns the parent shell of the face.
tangentiallyConnectedFaces Returns the set of faces that are tangentially adjacent to this face. In other words, it is the set of faces that are adjacent to this face's edges and have a smooth transition across those edges.
tempId Returns the temporary ID of this face. This ID is only good while the document remains open and as long as the owning BRepBody is not modified in any way. The findByTempId method of the BRepBody will return the entity in the body with the given ID.
vertices Returns the BRepVertices used by this face

Accessed From

BRepFace.createForAssemblyContext, BRepFace.nativeObject, BRepFaces.item, BRepLoop.face, ConstructionAxisCircularFaceDefinition.circularFace, ConstructionAxisPerpendicularAtPointDefinition.face, ConstructionPlaneTangentAtPointDefinition.tangentFace, Decal.faces, DecalInput.faces, DeleteFaceFeature.deletedFaces, DraftFeature.inputFaces, DraftFeatureInput.inputFaces, FaceRipFeatureDefinition.ripFace, FlatPattern.bottomFace, FlatPattern.topFace, LoftFeature.endFace, LoftFeature.startFace, MergeFacesFeatureInput.inputFaces, PatternElement.faces, Profile.face, SurfaceDeleteFaceFeature.deletedFaces, SweepFeature.guideSurfaces, SweepFeatureInput.guideSurfaces, TangentRelationshipInput.faceOne, ThreadFeature.inputCylindricalFace, ThreadFeatureInput.inputCylindricalFace, UntrimFeature.facesToUntrim, UntrimFeatureInput.facesToUntrim

Samples

Name Description
Patch Feature API Sample Demonstrates creating a new patch feature.

Version

Introduced in version August 2014