API Reference > OdBr Classes > OdBrEntity Class > OdBrEntity Methods > OdBrEntity::getSurfaceArea Method
OdBrEntity::getSurfaceArea Method
Collapse All
Syntax
C++
OdBrErrorStatus getSurfaceArea(double& dArea, const double& dTolRequired = dUnspecified, double& dTolAchieved = dUnspecified) const;
Parameters
Parameters 
Description 
double& dArea 
[out] Surface area 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 surface area of the entity as a double value. The surface area property is applicable for most entities, that represent volumetric figures. 

 

Remarks

If the surface area property is not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the surface area argument remains unchanged.

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