SHAPER  9.12.0
SketchSolver_ConstraintEqual Class Reference

Convert equality constraint to SolveSpace structure. More...

Inheritance diagram for SketchSolver_ConstraintEqual:
Inheritance graph

Public Member Functions

 SketchSolver_ConstraintEqual (ConstraintPtr theConstraint)
 Constructor based on SketchPlugin constraint. More...
 
virtual bool remove ()
 Tries to remove constraint. More...
 
void process (StoragePtr theStorage, bool theEvensBlocked)
 Initializes parameters and start constraint creation. More...
 
virtual void notify (const FeaturePtr &theFeature, PlaneGCSSolver_Update *theUpdater)
 Notify this object about the feature is changed somewhere. More...
 
virtual void update ()
 Update constraint. More...
 
virtual void blockEvents (bool isBlocked)
 Block or unblock events from this constraint. More...
 
virtual SketchSolver_ConstraintType getType () const
 Returns the type of constraint. More...
 
const std::string & error () const
 Shows error message. More...
 

Static Public Member Functions

static SketchSolver_ConstraintType TYPE (ConstraintPtr theConstraint)
 Obtain a type of SketchPlugin constraint. More...
 

Protected Member Functions

virtual void getAttributes (EntityWrapperPtr &theValue, std::vector< EntityWrapperPtr > &theAttributes)
 Generate list of attributes of constraint in order useful for constraints. More...
 
virtual void process ()
 Converts SketchPlugin constraint to a list of solver's constraints. More...
 
virtual void adjustConstraint ()
 This method is used in derived objects to check consistency of constraint. More...
 
void cleanErrorMsg ()
 Removes last error. More...
 

Protected Attributes

ConstraintPtr myBaseConstraint
 base SketchPlugin constraint More...
 
ConstraintWrapperPtr mySolverConstraint
 wrapper for PlaneGCS constraint More...
 
StoragePtr myStorage
 storage, which contains all information about entities and constraints More...
 
SketchSolver_ConstraintType myType
 type of constraint More...
 
std::list< EntityWrapperPtr > myAttributes
 attributes of constraint More...
 
std::string myErrorMsg
 error message More...
 

Detailed Description

Convert equality constraint to SolveSpace structure.

Constructor & Destructor Documentation

◆ SketchSolver_ConstraintEqual()

SketchSolver_ConstraintEqual::SketchSolver_ConstraintEqual ( ConstraintPtr  theConstraint)
inline

Constructor based on SketchPlugin constraint.

Member Function Documentation

◆ remove()

bool SketchSolver_ConstraintEqual::remove ( )
virtual

Tries to remove constraint.

Returns
false, if current constraint contains another SketchPlugin constraints (like for multiple coincidence)

Reimplemented from SketchSolver_Constraint.

◆ getAttributes()

void SketchSolver_ConstraintEqual::getAttributes ( EntityWrapperPtr &  theValue,
std::vector< EntityWrapperPtr > &  theAttributes 
)
protectedvirtual

Generate list of attributes of constraint in order useful for constraints.

Parameters
[out]theValuenumerical characteristic of constraint (e.g. distance)
[out]theAttributeslist of attributes to be filled

Reimplemented from SketchSolver_Constraint.

◆ process() [1/2]

void SketchSolver_Constraint::process ( StoragePtr  theStorage,
bool  theEvensBlocked 
)
inherited

Initializes parameters and start constraint creation.

Parameters
theStorage[in] storage where to place new constraint
theEventsBlocked[in] all events from this constraint should be blocked

◆ process() [2/2]

◆ notify()

virtual void SketchSolver_Constraint::notify ( const FeaturePtr &  theFeature,
PlaneGCSSolver_Update theUpdater 
)
inlinevirtualinherited

◆ update()

void SketchSolver_Constraint::update ( )
virtualinherited

◆ blockEvents()

void SketchSolver_Constraint::blockEvents ( bool  isBlocked)
virtualinherited

◆ TYPE()

SketchSolver_ConstraintType SketchSolver_Constraint::TYPE ( ConstraintPtr  theConstraint)
staticinherited

Obtain a type of SketchPlugin constraint.

◆ getType()

virtual SketchSolver_ConstraintType SketchSolver_Constraint::getType ( ) const
inlinevirtualinherited

Returns the type of constraint.

◆ error()

const std::string& SketchSolver_Constraint::error ( ) const
inlineinherited

Shows error message.

◆ adjustConstraint()

virtual void SketchSolver_Constraint::adjustConstraint ( )
inlineprotectedvirtualinherited

◆ cleanErrorMsg()

void SketchSolver_Constraint::cleanErrorMsg ( )
inlineprotectedinherited

Removes last error.

Field Documentation

◆ myBaseConstraint

ConstraintPtr SketchSolver_Constraint::myBaseConstraint
protectedinherited

base SketchPlugin constraint

◆ mySolverConstraint

ConstraintWrapperPtr SketchSolver_Constraint::mySolverConstraint
protectedinherited

wrapper for PlaneGCS constraint

◆ myStorage

StoragePtr SketchSolver_Constraint::myStorage
protectedinherited

storage, which contains all information about entities and constraints

◆ myType

SketchSolver_ConstraintType SketchSolver_Constraint::myType
protectedinherited

type of constraint

◆ myAttributes

std::list<EntityWrapperPtr> SketchSolver_Constraint::myAttributes
protectedinherited

attributes of constraint

◆ myErrorMsg

std::string SketchSolver_Constraint::myErrorMsg
protectedinherited

error message