API Reference > OdBr Classes > OdBrFace Class > OdBrFace Methods > OdBrFace::getArea Method
OdBrFace::getArea Method
Collapse All
Syntax
C++
OdBrErrorStatus getArea(double& area, const double* tolRequired = NULL, double* tolAchieved = NULL) const;
Parameters
Parameters 
Description 
double& area 
[out] Surface area of the face.  
const double* tolRequired = NULL 
[in] Optional tolerance required for the result of the calculation.  
double* tolAchieved = NULL 
[out] Optional tolerance achieved in the calculation. 
Returns
  • odbrNotImplementedYet - if the method is not implemented for the current modeler;
  • odbrUninitialisedObject - if object is uninitalised;
  • odbrInvalidInput - if calculation unsuccess;
  • odbrOK - if the calculation was successful;
Description

Provides the surface area of the face as a double value. 

 

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