Open CASCADE Technology 7.8.0
Public Member Functions
BRepPreviewAPI_MakeBox Class Reference

Builds a valid box, if points fulfill the conditions of a valid box. And allows to build a preview, otherwise. There are 4 cases: 1 - preview can be a vertex if thin box in all directions is a point; 2 - preview can be an edge if thin box in two directions is a point; 3 - preview can be a rectangular face if thin box in only one direction is a point; 4 - preview can be a valid box if point values fulfill the conditions of a valid box. More...

#include <BRepPreviewAPI_MakeBox.hxx>

Inheritance diagram for BRepPreviewAPI_MakeBox:
Inheritance graph
[legend]

Public Member Functions

 BRepPreviewAPI_MakeBox ()
 Constructor.
 
virtual void Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
 Creates a preview depending on point values.
 
- Public Member Functions inherited from BRepPrimAPI_MakeBox
 BRepPrimAPI_MakeBox ()
 Default constructor.
 
 BRepPrimAPI_MakeBox (const Standard_Real dx, const Standard_Real dy, const Standard_Real dz)
 Make a box with a corner at 0,0,0 and the other dx,dy,dz.
 
 BRepPrimAPI_MakeBox (const gp_Pnt &P, const Standard_Real dx, const Standard_Real dy, const Standard_Real dz)
 Make a box with a corner at P and size dx, dy, dz.
 
 BRepPrimAPI_MakeBox (const gp_Pnt &P1, const gp_Pnt &P2)
 Make a box with corners P1,P2.
 
 BRepPrimAPI_MakeBox (const gp_Ax2 &Axes, const Standard_Real dx, const Standard_Real dy, const Standard_Real dz)
 Make a box with Ax2 (the left corner and the axis) and size dx, dy, dz.
 
void Init (const Standard_Real theDX, const Standard_Real theDY, const Standard_Real theDZ)
 Init a box with a corner at 0,0,0 and the other theDX, theDY, theDZ.
 
void Init (const gp_Pnt &thePnt, const Standard_Real theDX, const Standard_Real theDY, const Standard_Real theDZ)
 Init a box with a corner at thePnt and size theDX, theDY, theDZ.
 
void Init (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2)
 Init a box with corners thePnt1, thePnt2.
 
void Init (const gp_Ax2 &theAxes, const Standard_Real theDX, const Standard_Real theDY, const Standard_Real theDZ)
 Init a box with Ax2 (the left corner and the theAxes) and size theDX, theDY, theDZ.
 
BRepPrim_WedgeWedge ()
 Returns the internal algorithm.
 
const TopoDS_ShellShell ()
 Returns the constructed box as a shell.
 
 operator TopoDS_Shell ()
 
const TopoDS_SolidSolid ()
 Returns the constructed box as a solid.
 
 operator TopoDS_Solid ()
 
const TopoDS_FaceBottomFace ()
 Returns ZMin face.
 
const TopoDS_FaceBackFace ()
 Returns XMin face.
 
const TopoDS_FaceFrontFace ()
 Returns XMax face.
 
const TopoDS_FaceLeftFace ()
 Returns YMin face.
 
const TopoDS_FaceRightFace ()
 Returns YMax face.
 
const TopoDS_FaceTopFace ()
 Returns ZMax face.
 
- Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual const TopoDS_ShapeShape ()
 Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.
 
 operator TopoDS_Shape ()
 
virtual const TopTools_ListOfShapeGenerated (const TopoDS_Shape &S)
 Returns the list of shapes generated from the shape .
 
virtual const TopTools_ListOfShapeModified (const TopoDS_Shape &S)
 Returns the list of shapes modified from the shape .
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &S)
 Returns true if the shape S has been deleted.
 
- Public Member Functions inherited from BRepBuilderAPI_Command
virtual ~BRepBuilderAPI_Command ()
 
virtual Standard_Boolean IsDone () const
 
void Check () const
 Raises NotDone if done is false.
 

Additional Inherited Members

- Protected Member Functions inherited from BRepBuilderAPI_MakeShape
 BRepBuilderAPI_MakeShape ()
 
- Protected Member Functions inherited from BRepBuilderAPI_Command
 BRepBuilderAPI_Command ()
 Set done to False.
 
void Done ()
 Set done to true.
 
void NotDone ()
 Set done to false.
 
- Protected Attributes inherited from BRepPrimAPI_MakeBox
BRepPrim_Wedge myWedge
 
- Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 

Detailed Description

Builds a valid box, if points fulfill the conditions of a valid box. And allows to build a preview, otherwise. There are 4 cases: 1 - preview can be a vertex if thin box in all directions is a point; 2 - preview can be an edge if thin box in two directions is a point; 3 - preview can be a rectangular face if thin box in only one direction is a point; 4 - preview can be a valid box if point values fulfill the conditions of a valid box.

Constructor & Destructor Documentation

◆ BRepPreviewAPI_MakeBox()

BRepPreviewAPI_MakeBox::BRepPreviewAPI_MakeBox ( )
inline

Constructor.

Member Function Documentation

◆ Build()

virtual void BRepPreviewAPI_MakeBox::Build ( const Message_ProgressRange theRange = Message_ProgressRange())
overridevirtual

Creates a preview depending on point values.

Reimplemented from BRepPrimAPI_MakeBox.


The documentation for this class was generated from the following file: