BRepShell Object

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

Description

Represents an entirely connected set of BRepFaces. A BRepLump may contain multiple BRepShells.

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().
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.
pointContainment Determines the relationship of the input point with respect to this shell.

Properties

Name Description
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 BRepShell 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.
body Returns the parent body of the shell.
boundingBox Returns the bounding box of this shell
edges returns the BRepEdges owned by this shell
entityToken Returns a token for the BRepShell object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same shell.

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 shells that exist in the design, (the isTemporary property is false).
faces Returns the BRepFaces directly owned by this shell
isClosed Returns true if this shell is closed
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVoid Returns true if the faces of this shell bound a void or an empty space within an outer shell.
lump Returns the parent lump of this shell.
meshManager Returns the mesh manager object for this shell.
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():
vertices Returns the BRepVertices owned by this shell
volume Returns the volume in cm ^ 3. Returns 0 in the case the shell is not solid.
wire Returns the wire body, if any, that exists in this shell. Returns null if the shell doesn't have a wire body.

Accessed From

BRepEdge.shell, BRepFace.shell, BRepShell.createForAssemblyContext, BRepShell.nativeObject, BRepShells.item, BRepVertex.shell

Version

Introduced in version August 2014