API Reference > OdBr Classes > OdBrEntity Class > OdBrEntity Methods > OdBrEntity::getMassProps Method
OdBrEntity::getMassProps Method
Collapse All
Syntax
C++
OdBrErrorStatus getMassProps(OdBrMassProps& massProps, const double& dDensity = dUnspecified, const double& dTolRequired = dUnspecified, double& dTolAchieved = dUnspecified) const;
Parameters
Parameters 
Description 
OdBrMassProps& massProps 
[out] Mass properties of the entity.  
const double& dDensity = dUnspecified 
[in] Density for calculating mass properties of the entity.  
const double& dTolRequired = dUnspecified 
[in] Tolerance required for the result of the calculation.  
double& dTolAchieved = dUnspecified 
[out] Tolerance achieved in the calculation.
 
Returns

A value of the OdBrErrorStatus type.

Description

Provides the mass properties for the entity. The mass properties are returned as an instance of OdBrMassProps structure. The density is used for the mass properties scaling and is the analogue of the physical value of the density of materials. The mass properties are applicable for those entities, that represent topology objects having volume property. 

 

Remarks

If density is not specified (dUnspecified), the default value is 1. If the mass properties are not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the mass properties argument remains unchanged.

Group
Copyright © 2002–2020. Open Design Alliance. All rights reserved.
Send feedback about this topic