Class: Body

Defines a Body.

Methods

Name Description
Activate() Activate the current object.
AddCommandSnippet() Creates a new CommandSnippet
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window.
ClearGeneratedData() Run the ClearGeneratedData action.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Duplicate() Creates a copy of the current DataModelObject.
GenerateMesh() Run the GenerateMesh action.
GetGeoBody() Gets the Geo Body
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
PreviewInflation() Run the PreviewInflation action.
PreviewSurfaceMesh() Run the PreviewSurfaceMesh action.
PropertyByAPIName(String) Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
ShowBody() Run the ShowBody action.
Update() Run the Update action.

Properties

Name Description
Assignment ***OBSOLETE*** Use 'Material' property instead. Gets or sets the Assignment.
Average Gets the Average.
BeamSection Gets the BeamSection.
Behavior Gets or sets the Behavior.
BrickIntegrationScheme Gets or sets the BrickIntegrationScheme.
CentroidX Gets the CentroidX.
CentroidY Gets the CentroidY.
CentroidZ Gets the CentroidZ.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
CrossSectionArea Gets the CrossSectionArea.
CrossSectionIYY Gets the CrossSectionIYY.
CrossSectionIZZ Gets the CrossSectionIZZ.
CrossSectionName Gets CrossSectionName.
CrossSectionSelection Gets or sets the CrossSectionSelection.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Dimension Gets or sets the Dimension.
Elements Gets the Elements.
FiberAngle Gets or sets the FiberAngle.
FiberCrossSectionArea Gets or sets the FiberCrossSectionArea.
FiberSpacing Gets or sets the FiberSpacing.
Figures Gets the list of associated figures.
FluidCrossArea Gets or sets the FluidCrossArea.
FluidDiscretization Gets or sets the FluidDiscretization.
FluidSolidPhase Gets or sets the FluidSolidPhase.
GeometryType Gets the GeometryType.
Hidden Hide or show the body.
HomogeneousMembrane Gets or sets the HomogeneousMembrane.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsWindingBody Gets the IsWindingBody.
Length Gets the Length.
LengthX Gets the LengthX.
LengthY Gets the LengthY.
LengthZ Gets the LengthZ.
LinkTrussBehavior Gets or sets the LinkTrussBehavior.
ManualThicknessMode Gets the ManualThicknessMode.
Mass Gets the Mass.
Material Gets or sets the Material.
Maximum Gets the Maximum.
MeshMetric Gets the MeshMetric.
MeshVersion Gets the MeshVersion.
Minimum Gets the Minimum.
ModelType Gets or sets the ModelType. Note: ModelType is applicable to line bodies and surface bodies only.
MomentOfInertiaIp1 Gets the MomentOfInertiaIp1.
MomentOfInertiaIp2 Gets the MomentOfInertiaIp2.
MomentOfInertiaIp3 Gets the MomentOfInertiaIp3.
Name Gets the name of the object.
Nodes Gets the Nodes.
NonlinearEffects Gets or sets the NonlinearEffects.
NumberOfTurns Gets or sets the NumberOfTurns.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
OffsetMode Gets or sets the OffsetMode.
OffsetType Gets or sets the OffsetType.
OffsetX Gets or sets the OffsetX.
OffsetY Gets or sets the OffsetY.
Parent Gets the parent object.
PipeExternalDiameter Gets the PipeExternalDiameter.
PipeInternalDiameter Gets the PipeInternalDiameter.
PipeThickness Gets the PipeThickness.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ReferenceFrame Gets or sets the ReferenceFrame.
ReferenceTemperature ***OBSOLETE*** Use 'UseReferenceTemperatureByBody' property instead. Gets or sets the ReferenceTemperature.
ReferenceTemperatureValue Gets or sets the ReferenceTemperatureValue.
ShellOffsetType Gets or sets the ShellOffsetType.
StandardDeviation Gets the StandardDeviation.
StiffnessBehavior Gets or sets the StiffnessBehavior.
Suppressed Gets or sets the Suppressed.
SurfaceArea Gets the SurfaceArea.
ThermalStrainEffects Gets or sets the ThermalStrainEffects.
Thickness Gets or sets the Thickness.
ThicknessMode ***OBSOLETE*** Use 'ManualThicknessMode' property instead. Gets the ThicknessMode.
Treatment Gets or sets the Treatment.
UseReferenceTemperatureByBody Gets or sets the UseReferenceTemperatureByBody.
UserNameChange Gets the UserNameChange.
Visible Gets or sets the Visible.
VisibleProperties Gets the list of properties that are visible for this object.
Volume Gets the Volume.