haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix BBOX_3D documentation

This commit is contained in:
kamp 2021-02-23 20:53:06 +01:00 committed by Seth Hillbrand
parent 2fd5f25c3c
commit 0a9a9d625e
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/bbox_3d.h
View File

@ -67,17 +67,16 @@ public:
/** /**
* Set bounding box with new parameters. * Set bounding box with new parameters.
* *
* @param aPbMin the minimum point to initialize the bounding box. * @param aPbMin the minimum point to set for the bounding box.
* @param aPbMax the maximum point to initialize the bounding box. * @param aPbMax the maximum point to set for the bounding box.
*/ */
void Set( const SFVEC3F& aPbMin, const SFVEC3F& aPbMax ); void Set( const SFVEC3F& aPbMin, const SFVEC3F& aPbMax );
void Set( const BBOX_3D& aBBox ); void Set( const BBOX_3D& aBBox );
/** /**
* @brief Set * @brief Set bounding box to one point.
* @param aPbMin * @param aPoint the single point to set the bounding box to.
* @param aPbMax
*/ */
void Set( const SFVEC3F& aPoint ); void Set( const SFVEC3F& aPoint );
@ -161,7 +160,7 @@ public:
bool IsInitialized() const; bool IsInitialized() const;
/** /**
* Reset the bounding box to zero and de-initialized it. * Reset the bounding box to zero and de-initialize it.
*/ */
void Reset(); void Reset();
@ -215,7 +214,7 @@ public:
float GetMaxDimension() const; float GetMaxDimension() const;
/** /**
* @return the surface are of the box. * @return the surface area of the box.
*/ */
float SurfaceArea() const; float SurfaceArea() const;