C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2
VSN::CuttingTool Class Reference

The tool to control planes of a dynamic section. More...

#include <vsn_cuttingtool.h>

+ Inheritance diagram for VSN::CuttingTool:
+ Collaboration diagram for VSN::CuttingTool:

Public Member Functions

 CuttingTool (CuttingUtil &, RenderLayersParameters &)
 Default constructor.
 
 ~CuttingTool ()
 Destructor.
 
bool IsEnabled () const
 Returns flag of dynamic section mode enabled.
 
void SetEnable (bool bEnable)
 Turns dynamic section mode on or off.
 
SectionPlaneId AddSectionPlane (const MbPlacement3D &plane)
 Adds section plane.
 
void DeleteSectionPlane (SectionPlaneId id)
 Deletes section plane.
 
bool IsEnabled (SectionPlaneId id) const
 Returns flag of section plane enabled.
 
void SetEnable (SectionPlaneId id, bool bEnable)
 Turns section plane on or off.
 
void Invert (SectionPlaneId id, bool bInvert)
 Changes isolated section.
 
bool IsInverted (SectionPlaneId id) const
 Flag of isolated section direction.
 
void CloseSectionPlane (SectionPlaneId id, bool fill)
 Closes shell received with specified plane.
 
bool IsClosedSectionPlane (SectionPlaneId id) const
 Checks if shell must be closed.
 
void EnableInteractiveMode (SectionPlaneId id, bool bEnable)
 Enables interactive mode with manipulator.
 
bool IsEnabledInteractiveMode (SectionPlaneId id) const
 Checks interactive mode with manipulator.
 
const MbPlacement3DGetPlacement (SectionPlaneId id) const
 Returns plane math.
 
void GetParams (SectionPlaneId id, double &angle1, double &angle2, double &offset) const
 Returns plane parameters (angle in degrees). More...
 
void SetSurfaceMaterial (SectionPlaneId id, std::shared_ptr< Material > material)
 Material of created plane for closed shell ("cover"). More...
 
void Init (SectionPlaneId id, const MbPlacement3D &plane)
 Changes plane parameters.
 
void Init (SectionPlaneId id, double angle1, double angle2, double offset)
 Changes plane parameters (angle in degrees). More...
 
 VSN_SIGNAL (Public, OnChangePlacement, void OnChangePlacement(SectionPlaneId id), id)
 Signal about modifying plane position with manipulators.
 
std::list< SectionPlaneIdGetSectionPlanes () const
 Returns list of all created planes.
 
void RenderPlanes (const MbCube &gab) const
 Renders planes. More...
 
RenderContainerGetWidgets3D ()
 Returns manipulator container.
 
- Public Member Functions inherited from VSN::Object
 Object (Object *pParent=nullptr)
 Default constructor. More...
 
virtual ~Object ()
 Destructor.
 
void SetParent (Object *pParent)
 NO TRANSLATION.
 
MutexGetMutex ()
 Object mutex.
 
String GetObjectName () const
 Returns name.
 
void SetObjectName (const String &name)
 Sets name.
 
bool IsControlType () const
 TRANSLATION.
 
ObjectGetParent () const
 NO TRANSLATION.
 
Variant GetProperty (const String &name) const
 NO TRANSLATION.
 
bool IsSignalsBlocked () const
 NO TRANSLATION.
 
bool SetBlockSignals (bool bBlock)
 NO TRANSLATION.
 
void AddEventListener (Object *pObject)
 NO TRANSLATION.
 
void RemoveEventListener (Object *pObject)
 NO TRANSLATION.
 
ObjectGetSender () const
 NO TRANSLATION.
 
Thread * GetThread () const
 NO TRANSLATION.
 
void BindWithThread (Thread *thread)
 NO TRANSLATION.
 
int StartTimer (int interval, TimerType timerType=tt_CoarseTimer)
 NO TRANSLATION.
 
void KillTimer (int id)
 NO TRANSLATION.
 
const ObjectList< Object * > & GetChildren () const
 NO TRANSLATION.
 
template<typename T >
FindChild (const String &objName=String()) const
 NO TRANSLATION.
 
template<typename T >
ObjectList< T > FindChildren (const String &objName=String(), VSN::ChildFindingPolicies policies=VSN::FindAllNestedChildren) const
 NO TRANSLATION.
 
- Public Member Functions inherited from VSN::BasicObject
 BasicObject ()
 Default constructor.
 
virtual ~BasicObject ()
 Destructor.
 

Detailed Description

The tool to control planes of a dynamic section.

Member Function Documentation

◆ GetParams()

void VSN::CuttingTool::GetParams ( SectionPlaneId  id,
double &  angle1,
double &  angle2,
double &  offset 
) const

Returns plane parameters (angle in degrees).

Parameters
[in]id- Plane identifier.
[in]angle1- The first angle of normal direction.
[in]angle2- The second angle of normal direction.
[in]offset- Plane offset.

◆ SetSurfaceMaterial()

void VSN::CuttingTool::SetSurfaceMaterial ( SectionPlaneId  id,
std::shared_ptr< Material material 
)

Material of created plane for closed shell ("cover").

Parameters
[in]id- Plane identifier.
[in]material- Material.

◆ Init()

void VSN::CuttingTool::Init ( SectionPlaneId  id,
double  angle1,
double  angle2,
double  offset 
)

Changes plane parameters (angle in degrees).

Parameters
[in]idPlane identifier.
[in]angle1- The first angle of normal direction.
[in]angle2- The second angle of normal direction.
[in]offset- Plane offset.

◆ RenderPlanes()

void VSN::CuttingTool::RenderPlanes ( const MbCube gab) const

Renders planes.

Parameters
[in]gab- Size in which planes must be displayed.

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