SHAPER  9.12.0
PartSet_PreviewPlanes Class Reference

A class to show/hide sketch preview planes. More...

Public Member Functions

 PartSet_PreviewPlanes ()
 Constructor. More...
 
bool isPreviewDisplayed () const
 Returns if the preview was displayed. More...
 
bool isPreviewShape (std::shared_ptr< GeomAPI_Shape > theShape)
 Returns true if the shape is one of the preview shapes. More...
 
void erasePreviewPlanes (ModuleBase_IWorkshop *theWorkshop)
 Erase preview planes. More...
 
void showPreviewPlanes (ModuleBase_IWorkshop *theWorkshop)
 Show preview planes. More...
 

Static Public Member Functions

static bool hasVisualizedBodies (ModuleBase_IWorkshop *theWorkshop)
 Returns true if there is body visualized in the viewer. More...
 
static bool hasVisualizedSketch (ModuleBase_IWorkshop *theWorkshop)
 Returns true if there is at least one Sketch visualized in the viewer. More...
 

Detailed Description

A class to show/hide sketch preview planes.

Constructor & Destructor Documentation

◆ PartSet_PreviewPlanes()

PartSet_PreviewPlanes::PartSet_PreviewPlanes ( )

Constructor.

Member Function Documentation

◆ hasVisualizedBodies()

bool PartSet_PreviewPlanes::hasVisualizedBodies ( ModuleBase_IWorkshop theWorkshop)
static

Returns true if there is body visualized in the viewer.

Parameters
theWorkshopthe application workshop
Returns
boolean value

◆ hasVisualizedSketch()

bool PartSet_PreviewPlanes::hasVisualizedSketch ( ModuleBase_IWorkshop theWorkshop)
static

Returns true if there is at least one Sketch visualized in the viewer.

Parameters
theWorkshopthe application workshop
Returns
boolean value

◆ isPreviewDisplayed()

bool PartSet_PreviewPlanes::isPreviewDisplayed ( ) const
inline

Returns if the preview was displayed.

Returns
boolean value

◆ isPreviewShape()

bool PartSet_PreviewPlanes::isPreviewShape ( std::shared_ptr< GeomAPI_Shape theShape)

Returns true if the shape is one of the preview shapes.

Parameters
theShapea shape to be checked
Returns
boolean value

◆ erasePreviewPlanes()

void PartSet_PreviewPlanes::erasePreviewPlanes ( ModuleBase_IWorkshop theWorkshop)

Erase preview planes.

Parameters
theWorkshopthe application workshop

◆ showPreviewPlanes()

void PartSet_PreviewPlanes::showPreviewPlanes ( ModuleBase_IWorkshop theWorkshop)

Show preview planes.

Parameters
theWorkshopthe application workshop