AreaMassProperties

References
Contains 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

Area

#Since v5.0
Gets the area solution.
public double Area { get; }

AreaError

#Since v5.0
Gets the uncertainty in the area calculation.
public double AreaError { get; }

Centroid

#Since v5.0
Gets the area centroid in the world coordinate system.
public Point3d Centroid { get; }

CentroidCoordinatesMomentsOfInertia

#Since v5.0
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.
public Vector3d CentroidCoordinatesMomentsOfInertia { get; }
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.

CentroidCoordinatesMomentsOfInertiaError

#Since v5.0
Uncertainty in centroid coordinates moments of inertia calculation.
public Vector3d CentroidCoordinatesMomentsOfInertiaError { get; }

CentroidCoordinatesProductMoments

#Since v6.26
Product moments with respect to centroid coordinate system.
public Vector3d CentroidCoordinatesProductMoments { get; }

CentroidCoordinatesProductMomentsError

#Since v6.26
Uncertainty in product moments with respect to centroid coordinate system.
public Vector3d CentroidCoordinatesProductMomentsError { get; }

CentroidCoordinatesRadiiOfGyration

#Since v5.0
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.
public Vector3d CentroidCoordinatesRadiiOfGyration { get; }
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.

CentroidCoordinatesSecondMoments

#Since v5.0
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.
public Vector3d CentroidCoordinatesSecondMoments { get; }

CentroidCoordinatesSecondMomentsError

#Since v5.0
Uncertainty in centroid coordinates second moments calculation.
public Vector3d CentroidCoordinatesSecondMomentsError { get; }

CentroidError

#Since v5.0
Gets the uncertainty in the centroid calculation.
public Vector3d CentroidError { get; }

WorldCoordinatesFirstMoments

#Since v5.0
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.
public Vector3d WorldCoordinatesFirstMoments { get; }

WorldCoordinatesFirstMomentsError

#Since v5.0
Uncertainty in world coordinates first moments calculation.
public Vector3d WorldCoordinatesFirstMomentsError { get; }

WorldCoordinatesMomentsOfInertia

#Since v5.0
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.
public Vector3d WorldCoordinatesMomentsOfInertia { get; }
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.

WorldCoordinatesMomentsOfInertiaError

#Since v5.0
Uncertainty in world coordinates moments of inertia calculation.
public Vector3d WorldCoordinatesMomentsOfInertiaError { get; }

WorldCoordinatesProductMoments

#Since v5.0
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.
public Vector3d WorldCoordinatesProductMoments { get; }

WorldCoordinatesProductMomentsError

#Since v5.0
Uncertainty in world coordinates second moments calculation.
public Vector3d WorldCoordinatesProductMomentsError { get; }

WorldCoordinatesRadiiOfGyration

#Since v5.0
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)
public Vector3d WorldCoordinatesRadiiOfGyration { get; }
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.

WorldCoordinatesSecondMoments

#Since v5.0
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.
public Vector3d WorldCoordinatesSecondMoments { get; }

WorldCoordinatesSecondMomentsError

#Since v5.0
Uncertainty in world coordinates second moments calculation.
public Vector3d WorldCoordinatesSecondMomentsError { get; }

Methods

CentroidCoordinatesPrincipalMoments

#Since v6.9
Calculates the eigenvalues and eigenvectors of the moments matrix with respect to centroid coordinates.
public bool CentroidCoordinatesPrincipalMoments(
out double
x,
Principal moment.
xaxis,
Principal axis for x.
out double
y,
Principal moment.
yaxis,
Principal axis for y.
out double
z,
Principal moment.
zaxis
Principal axis for z.
)
true if successful.

CentroidCoordinatesPrincipalMomentsOfInertia

#Since v7.3
Calculates the principal moments of inertia and principal axes with respect to centroid coordinates.
public bool CentroidCoordinatesPrincipalMomentsOfInertia(
out double
x,
Principal moment.
xaxis,
Principal axis for x.
out double
y,
Principal moment.
yaxis,
Principal axis for y.
out double
z,
Principal moment.
zaxis
Principal axis for z.
)
true if successful.

Compute

#Since v7.10
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.
)
The AreaMassProperties for the given Brep or null on failure.
ArgumentNullExceptionWhen brep is null.

Compute

#Since v6.3
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.
)
The AreaMassProperties for the given Brep or null on failure.
ArgumentNullExceptionWhen brep is null.

Compute

#Since v5.0
Computes an AreaMassProperties for a brep.
public static AreaMassProperties Compute(
brep
Brep to measure.
)
The AreaMassProperties for the given Brep or null on failure.
ArgumentNullExceptionWhen brep is null.

Compute

#Since v5.0
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
)
The AreaMassProperties for the given curve or null on failure.
ArgumentNullExceptionWhen closedPlanarCurve is null.

Compute

#Since v5.0
Computes an AreaMassProperties for a closed planar curve.
public static AreaMassProperties Compute(
closedPlanarCurve
Curve to measure.
)
The AreaMassProperties for the given curve or null on failure.
ArgumentNullExceptionWhen closedPlanarCurve is null.

Compute

#Since v5.0
Computes an AreaMassProperties for a hatch.
public static AreaMassProperties Compute(
hatch
Hatch to measure.
)
The AreaMassProperties for the given hatch or null on failure.
ArgumentNullExceptionWhen hatch is null.

Compute

#Since v6.3
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.
)
The AreaMassProperties for the entire collection or null on failure.

Compute

#Since v5.1
Computes the Area properties 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.
)
The Area properties for the entire collection or null on failure.

Compute

#Since v6.3
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.
)
The AreaMassProperties for the given Mesh or null on failure.
ArgumentNullExceptionWhen mesh is null.

Compute

#Since v5.0
Computes an AreaMassProperties for a mesh.
public static AreaMassProperties Compute(
Mesh
mesh
Mesh to measure.
)
The AreaMassProperties for the given Mesh or null on failure.
ArgumentNullExceptionWhen mesh is null.

Compute

#Since v6.3
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.
)
The AreaMassProperties for the given Surface or null on failure.
ArgumentNullExceptionWhen surface is null.

Compute

#Since v5.0
Computes an AreaMassProperties for a surface.
public static AreaMassProperties Compute(
surface
Surface to measure.
)
The AreaMassProperties for the given Surface or null on failure.
ArgumentNullExceptionWhen surface is null.

Dispose

#Since v5.0
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

#Since v9.0
Sum mass properties together to get an aggregate mass.
public bool Sum(
summand
mass properties to add.
)
true if successful.

Sum

#Since v9.0
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.
)
True if successful.

WeightedSum

#Since v9.0
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.
)
An AreaMassProperties containing the result if successful, null if a failure occurs.
ArgumentNullExceptionWhen summands or weights is null.

WorldCoordinatesPrincipalMoments

#Since v6.9
Calculates the eigenvalues and eigenvectors of moments matrix in world coordinates.
public bool WorldCoordinatesPrincipalMoments(
out double
x,
Principal moment.
xaxis,
Principal axis for x.
out double
y,
Principal moment.
yaxis,
Principal axis for y.
out double
z,
Principal moment.
zaxis
Principal axis for z.
)
true if successful.

WorldCoordinatesPrincipalMomentsOfInertia

#Since v7.3
Calculates the principal moments of inertia and principal axes with respect to world coordinates.
public bool WorldCoordinatesPrincipalMomentsOfInertia(
out double
x,
Principal moment.
xaxis,
Principal axis for x.
out double
y,
Principal moment.
yaxis,
Principal axis for y.
out double
z,
Principal moment.
zaxis
Principal axis for z.
)
true if successful.