AreaMassProperties
ReferencesContains static initialization methods and allows access to the computed metrics of area, area centroid and area moments in closed planar curves, in meshes, in surfaces, in hatches and in boundary representations.
Finalizer
~AreaMassProperties
#Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
~AreaMassProperties()
Properties
Gets the area centroid in the world coordinate system.
Moments of inertia with respect to centroid coordinate system. X = integral of ((y-y0)^2 + (z-z0)^2) dm Y = integral of ((z-z0)^2 + (x-x0)^2) dm Z = integral of ((z-z0)^2 + (y-y0)^2) dm where (x0,y0,z0) = centroid.
Remarks: What is meant by "moments of inertia" varies widely in textbooks and papers. The values returned here are the integrals listed in the Summary section. Some applications may want the values from WorldCoordinatesSecondMoments instead of the values returned here.
Uncertainty in centroid coordinates moments of inertia calculation.
Product moments with respect to centroid coordinate system.
Uncertainty in product moments with respect to centroid coordinate system.
Radii of gyration with respect to centroid coordinate system. X = sqrt(integral of ((y-y0)^2 + (z-z0)^2) dm/M) Y = sqrt(integral of ((z-z0)^2 + (x-x0)^2) dm/M) Z = sqrt(integral of ((z-z0)^2 + (y-y0)^2) dm/M) where (x0,y0,z0) = centroid.
Remarks: What is meant by "radii of gyration" varies widely in textbooks and papers. The values returned here are the integrals listed in the Returns section.
Second moments with respect to centroid coordinate system. X = integral of (x-x0)^2 dm Y = integral of (y-y0)^2 dm Z = integral of (z-z0)^2 dm where (x0,y0,z0) = centroid.
Uncertainty in centroid coordinates second moments calculation.
Gets the uncertainty in the centroid calculation.
Returns the world coordinate first moments if they were able to be calculated. X is integral of "x dm" over the area Y is integral of "y dm" over the area Z is integral of "z dm" over the area.
Uncertainty in world coordinates first moments calculation.
The moments of inertia about the world coordinate axes. X = integral of (y^2 + z^2) dm Y = integral of (z^2 + x^2) dm Z = integral of (z^2 + y^2) dm.
Remarks: What is meant by "moments of inertia" varies widely in textbooks and papers. The values returned here are the integrals listed in the Summary section. Some applications may want the values from WorldCoordinatesSecondMoments instead of the values returned here.
Uncertainty in world coordinates moments of inertia calculation.
Returns the world coordinate product moments if they were able to be calculated. X is integral of "xy dm" over the area Y is integral of "yz dm" over the area Z is integral of "zx dm" over the area.
Uncertainty in world coordinates second moments calculation.
Radii of gyration with respect to world coordinate system. X = sqrt(integral of (y^2 + z^2) dm/M) Y = sqrt(integral of (z^2 + x^2) dm/M) Z = sqrt(integral of (z^2 + y^2) dm/M)
Remarks: What is meant by "radii of gyration" varies widely in textbooks and papers. The values returned here are the integrals listed in the Returns section.
Returns the world coordinate second moments if they were able to be calculated. X is integral of "xx dm" over the area Y is integral of "yy dm" over the area Z is integral of "zz dm" over the area.
Methods
Calculates the eigenvalues and eigenvectors of the moments matrix with respect to centroid coordinates.
Returns: true if successful.
Calculates the principal moments of inertia and principal axes with respect to centroid coordinates.
Returns: true if successful.
Compute the AreaMassProperties for a single Brep.
public static AreaMassProperties Compute()
brep,
Brep to measure.
area,
true to calculate area.
firstMoments,
true to calculate area first moments, area, and area centroid.
secondMoments,
true to calculate area second moments.
productMoments,
true to calculate area product moments.
relativeTolerance,
The relative tolerance used for the calculation. In overloads of this function where tolerances are not specified, 1.0e-6 is used.
absoluteTolerance
The absolute tolerancwe used for the calculation. In overloads of this function where tolerances are not specified, 1.0e-6 is used.
Returns: The AreaMassProperties for the given Brep or null on failure.
Exceptions:
| ArgumentNullException | When brep is null. |
Compute the AreaMassProperties for a single Brep.
Returns: The AreaMassProperties for the given Brep or null on failure.
Exceptions:
| ArgumentNullException | When brep is null. |
Computes an AreaMassProperties for a brep.
Returns: The AreaMassProperties for the given Brep or null on failure.
Exceptions:
| ArgumentNullException | When brep is null. |
Computes an AreaMassProperties for a closed planar curve.
public static AreaMassProperties Compute()
closedPlanarCurve,
Curve to measure.
planarTolerance
absolute tolerance used to insure the closed curve is planar
Returns: The AreaMassProperties for the given curve or null on failure.
Exceptions:
| ArgumentNullException | When closedPlanarCurve is null. |
Computes an AreaMassProperties for a closed planar curve.
Returns: The AreaMassProperties for the given curve or null on failure.
Exceptions:
| ArgumentNullException | When closedPlanarCurve is null. |
Computes an AreaMassProperties for a hatch.
Returns: The AreaMassProperties for the given hatch or null on failure.
Exceptions:
| ArgumentNullException | When hatch is null. |
Computes the AreaMassProperties for a collection of geometric objects. At present only Breps, Surfaces, Meshes and Planar Closed Curves are supported.
public static AreaMassProperties Compute()
geometry,
Objects to include in the area computation.
area,
true to calculate area.
firstMoments,
true to calculate area first moments, area, and area centroid.
secondMoments,
true to calculate area second moments.
productMoments
true to calculate area product moments.
Returns: The AreaMassProperties for the entire collection or null on failure.
Computes the Area properties for a collection of geometric objects. At present only Breps, Surfaces, Meshes and Planar Closed Curves are supported.
Returns: The Area properties for the entire collection or null on failure.
Compute the AreaMassProperties for a single Mesh.
public static AreaMassProperties Compute()
Mesh
mesh,
Mesh to measure.
area,
true to calculate area.
firstMoments,
true to calculate area first moments, area, and area centroid.
secondMoments,
true to calculate area second moments.
productMoments
true to calculate area product moments.
Returns: The AreaMassProperties for the given Mesh or null on failure.
Exceptions:
| ArgumentNullException | When mesh is null. |
Computes an AreaMassProperties for a mesh.
Returns: The AreaMassProperties for the given Mesh or null on failure.
Exceptions:
| ArgumentNullException | When mesh is null. |
Compute the AreaMassProperties for a single Surface.
public static AreaMassProperties Compute()
surface,
Surface to measure.
area,
true to calculate area.
firstMoments,
true to calculate area first moments, area, and area centroid.
secondMoments,
true to calculate area second moments.
productMoments
true to calculate area product moments.
Returns: The AreaMassProperties for the given Surface or null on failure.
Exceptions:
| ArgumentNullException | When surface is null. |
Computes an AreaMassProperties for a surface.
Returns: The AreaMassProperties for the given Surface or null on failure.
Exceptions:
| ArgumentNullException | When surface is null. |
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
Dispose
#For derived class implementers.
This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.
protected virtual void Dispose()
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
Sum mass properties together to get an aggregate mass.
Returns: true if successful.
Sum mass properties together to get an aggregate mass.
public bool Sum()
summands,
An array of mass properties to add.
bAddTo
If true, then the summands are added to the existing mass.
Returns: True if successful.
Exceptions:
| ArgumentNullException |
Sum a list of mass properties together to get an aggregate mass, weighting each by a density factor.Ignores existing mass properties in this object.
public static AreaMassProperties WeightedSum()
summands,
An array of mass properties to add.
weights
An array of non-negative densities, of the same length as summands.
Returns: An AreaMassProperties containing the result if successful, null if a failure occurs.
Exceptions:
| ArgumentNullException | When summands or weights is null. |
Calculates the eigenvalues and eigenvectors of moments matrix in world coordinates.
Returns: true if successful.
Calculates the principal moments of inertia and principal axes with respect to world coordinates.
Returns: true if successful.