BRepBody Object

Description

Methods

Properties

Name	Description
appearance	Read-write property that gets and sets the current appearance of the body. Setting this property will result in applying an override appearance to the body and the AppearanceSourceType property will return OverrideAppearanceSource. Setting this property to null will remove any override. This property is only valid if the IsTransient property is false.
appearanceSourceType	Read-write property that gets the source of the appearance for the body. If this returns OverrideAppearanceSource, an override exists on this body. The override can be removed by setting the Appearance property to null. This property is only valid if the IsTransient property is false.
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 BRepBody 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. Also returns null in the case where this body is transient.
attributes	Returns the collection of attributes associated with this face.
baseFeature	If this body is associated with a base feature, this property will return that base feature. If it's not associated with a base feature, this property will return null.
boundingBox	Returns the bounding box of this body.
concaveEdges	Returns all of the edges that connect concave faces.
convexEdges	Returns all of the edges that connect convex faces.
edges	Returns a collection of all of the edges in the body.
entityToken	Returns a token for the BRepBody object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same body. 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 bodies that exist in the design, (the isTemporary property is false).
faces	Returns a collection of all of the faces in the body.
isLightBulbOn	Gets and set if the light bulb beside the body node in the browser is on or not. Parent nodes in the browser can have their light bulb off which affects all of their children so this property does not indicate if the body is actually visible, just that it should be visible if all of it's parent nodes are also visible. Use the isVisible property to determine if it's actually visible. This property is only valid if the IsTransient property is false.
isSelectable	Gets and sets if this body is selectable. This property is only valid if the IsTransient property is false.
isSheetMetal	Indicates if this body represents a sheet metal folded part or not and if a flat pattern can be created.
isSolid	Returns whether this body is closed (solid) or not.
isTemporary	Indicates if this body is represented in the model or is temporary.
isTransient	Indicates if this body is represented in the model or is transient.
isValid	Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVisible	Gets if this body is currently visible in the graphics window. Use the isLightBulbOn to change if the light bulb beside the body node in the browser is on or not. Parent nodes in the browser can have their light bulb off which affects all of their children. This property indicates the final result and whether this body is actually visible or not. This property is only valid if the IsTransient property is false.
lumps	Returns a collection of all of the lumps in the body.
material	Gets and sets the material assigned to this body. This property is only valid if the IsTransient property is false.
meshManager	Returns the mesh manager object for this body.
name	Gets and sets the name of the body. This property is only valid if the IsTransient property is false.
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():
opacity	Gets and sets the opacity override assigned to this body. A value of 1.0 specifies that is it completely opaque and a value of 0.0 specifies that is it completely transparent. This value is not necessarily related to what the user sees because the opacity is inherited. For example, if you this body is in a component and that component's opacity is set to something other than 1.0, the body will also be shown as slightly transparent even though the opacity property for the body will return 1.0. Because the component that contains the body can be referenced as an occurrence in other components and they can have different opacity settings, it's possible that different instances of the same body can display using different opacity levels. To get the opacity that it is being displayed with use the BrepBody.visibleOpacity property. This is the API equivalent of the "Opacity Control" command available for the body in the browser.
orientedMinimumBoundingBox	Returns an oriented bounding box of the body that is best oriented to tightly fit the body.
parentComponent	Returns the component this body is owned by.
physicalProperties	Returns the PhysicalProperties object that has properties for getting the area, density, mass, volume, moments, etc of this body. Property values will be calculated using the 'LowCalculationAccuracy' setting when using this property to get the PhysicalProperties object. To specify a higher calculation tolerance, use the getPhysicalProperties method on the Design class instead.
preciseBoundingBox	Returns a bounding box that tightly fits this body.
revisionId	Returns the current revision ID of the body. This ID changes any time the body is modified in any way. By getting and saving the ID when you create any data that is dependent on the body, you can then compare the saved ID with the current ID to determine if the body has changed to know if you should update your data.
shells	Returns a collection of all of the shells in the body.
textureMapControl	Returns the TextureMapControl object associated with this body when there is an appearance assigned to the body that has a texture associated with it. If there isn't a texture, this property will return null. If there is a texture, you can use the returned object to query and modify how the texture is applied to the body.
vertices	Returns a collection of all of the vertices in the body.
visibleOpacity	The user can set an override opacity for components and bodies these opacity overrides combine if children and parent components have overrides. This property returns the actual opacity that is being used to render the body. To set the opacity use the opacity property of the BRepBody object.
volume	Returns the volume in cm ^ 3. Returns 0 in the case the body is not solid.
wires	Returns any wire bodies that exist within this body.

Accessed From

Samples

Version