Builds offset curves in the sketch. More...

Inheritance diagram for SketchPlugin_Offset:

Public Member Functions
virtual SKETCHPLUGIN_EXPORT const std::string &	getKind ()
	Returns the kind of a feature. More...

virtual SKETCHPLUGIN_EXPORT void	attributeChanged (const std::string &theID)
	Called on change of any argument-attribute of this object. More...

virtual SKETCHPLUGIN_EXPORT void	execute ()
	Creates a new part document if needed. More...

virtual SKETCHPLUGIN_EXPORT bool	isPreviewNeeded () const
	Returns true if preview update during the edition needed. More...

virtual SKETCHPLUGIN_EXPORT bool	customAction (const std::string &theActionId)
	Find edges connected by coincident boundary constraint and composing a wire with the already selected segments. More...

virtual SKETCHPLUGIN_EXPORT AISObjectPtr	getAISObject (AISObjectPtr thePrevious)
	Returns the AIS preview. More...

	SketchPlugin_Offset ()
	Use plugin manager for features creation. More...

virtual bool	isZeroValueAllowed ()
	Get if a constraint is able to have a zero numeric value. More...

virtual void	setNumericValue (const double theValue)
	Set numeric value to attribute VALUE() More...

virtual double	getNumericValue ()
	Get numeric value of attribute VALUE() More...

virtual bool	isInHistory ()
	Returns true if this feature must be displayed in the history (top level of Part tree) More...

virtual bool	isExternal () const
	Returns true of the feature is created basing on the external shape of not-this-sketch object. More...

virtual bool	isCopy () const
	Returns true if the feature is a copy of other feature. More...

virtual bool	canBeDisplayed () const
	Returns true if the feature and the feature results can be displayed. More...

virtual bool	isFixed ()
	Returns true is sketch element is under the rigid constraint. More...

SketchPlugin_Sketch *	sketch ()
	Returns the sketch of this feature. More...

virtual std::shared_ptr< ModelAPI_Document >	document () const
	Returns document this feature belongs to. More...

std::shared_ptr< ModelAPI_AttributeDocRef >	document (const std::string &theID)
	Returns the document reference attribute. More...

virtual std::string	groupName ()
	Returns the group identifier of this result. More...

virtual bool	compute (const std::string &)
	Computes the attribute value on the base of other attributes if the value can be computed. More...

virtual MODELAPI_EXPORT void	setError (const std::string &theError, bool isSend=true, bool isTranslate=true)
	Registers error during the execution, causes the ExecutionFailed state. More...

virtual std::string	error () const
	Returns error, arose during the execution. More...

MODELAPI_EXPORT const std::list< std::shared_ptr< ModelAPI_Result > > &	results ()
	returns the current results of the feature More...

MODELAPI_EXPORT std::shared_ptr< ModelAPI_Result >	firstResult () const
	returns the first result in the list or NULL reference More...

MODELAPI_EXPORT std::shared_ptr< ModelAPI_Result >	lastResult ()
	returns the last result in the list or NULL reference More...

MODELAPI_EXPORT void	setResult (const std::shared_ptr< ModelAPI_Result > &theResult)
	sets the alone result More...

MODELAPI_EXPORT void	setResult (const std::shared_ptr< ModelAPI_Result > &theResult, const int theIndex)
	sets the result by index (zero based), results before this must be set before More...

MODELAPI_EXPORT void	removeResults (const int theSinceIndex, const bool theForever=true, const bool theFlush=true)
	removes all results starting from the given index (zero-based) More...

MODELAPI_EXPORT void	eraseResults (const bool theForever=true)
	removes all results from the feature More...

virtual MODELAPI_EXPORT void	erase ()
	removes all fields from this feature: results, data, etc More...

MODELAPI_EXPORT void	eraseResultFromList (const std::shared_ptr< ModelAPI_Result > &theResult)
	removes the result from the list of feature (not doing in disabled): normally this method is not used from features. More...

virtual bool	isPersistentResult ()
	Returns true if result is persistent (stored in document) and on undo-redo, save-open it is not needed to recompute it. More...

virtual bool	isAction ()
	Returns true if this feature must not be created: this is just an action that is not stored in the features history and data model (like "delete part"). More...

virtual MODELAPI_EXPORT bool	isMacro () const
	Returns true if this feature is used as macro: creates other features and then removed. More...

virtual MODELAPI_EXPORT const std::string &	documentToAdd ()
	Must return document where the new feature must be added to By default it is empty: it is added to the document this method is called to. More...

virtual MODELAPI_EXPORT bool	setDisabled (const bool theFlag)
	Enables/disables the feature. More...

virtual MODELAPI_EXPORT bool	isDisabled ()
	Returns the feature is disabled or not. More...

virtual MODELAPI_EXPORT bool	setStable (const bool theFlag)
	Set the stable feature flag. More...

virtual MODELAPI_EXPORT bool	isStable ()
	Returns the feature is stable or not. More...

virtual MODELAPI_EXPORT bool	isEditable ()
	Returns the feature is editable or not. Most of features are editable. More...

virtual MODELAPI_EXPORT ListOfShape	vertices (const bool theOnlyUnique=false)
	Returns all the vertices produced by this feature. More...

virtual MODELAPI_EXPORT ListOfShape	edges (const bool theOnlyUnique=false)
	Returns all the edges produced by this feature. More...

virtual MODELAPI_EXPORT ListOfShape	wires (const bool theOnlyUnique=false)
	Returns all the wires produced by this feature. More...

virtual MODELAPI_EXPORT ListOfShape	faces (const bool theOnlyUnique=false)
	Returns all the faces produced by this feature. More...

virtual MODELAPI_EXPORT ListOfShape	shells (const bool theOnlyUnique=false)
	Returns all the shells produced by this feature. More...

virtual MODELAPI_EXPORT ListOfShape	solids (const bool theOnlyUnique=false)
	Returns all the solids produced by this feature. More...

std::wstring	name ()
	Returns the name stored in the attribute. More...

std::shared_ptr< ModelAPI_AttributeBoolean >	boolean (const std::string &theID)
	Returns the Boolean attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeDouble >	real (const std::string &theID)
	Returns the real attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeInteger >	integer (const std::string &theID)
	Returns the integer attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeIntArray >	intArray (const std::string &theID)
	Returns the integer array attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeRefAttr >	refattr (const std::string &theID)
	Returns the reference attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeRefAttrList >	refattrlist (const std::string &theID)
	Returns the refattrlist attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeReference >	reference (const std::string &theID)
	Returns the reference attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeRefList >	reflist (const std::string &theID)
	Returns the list of references attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeSelection >	selection (const std::string &theID)
	Returns the shape selection attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeSelectionList >	selectionList (const std::string &theID)
	Returns the list of shape selections attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeString >	string (const std::string &theID)
	Returns the string attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeStringArray >	stringArray (const std::string &theID)
	Returns the string array attribute by the identifier. More...

std::shared_ptr< ModelAPI_AttributeTables >	tables (const std::string &theID)
	Returns the tables attribute by the identifier. More...

std::shared_ptr< ModelAPI_Attribute >	attribute (const std::string &theID)
	Returns the attribute by the identifier. More...

virtual void	setInHistory (const std::shared_ptr< ModelAPI_Object > theObject, const bool theFlag)
	Makes object presented or not in the history of the created objects. More...

virtual std::shared_ptr< ModelAPI_Data >	data () const
	Returns the data manager of this object: attributes. More...

virtual bool	isSame (const std::shared_ptr< ModelAPI_Object > &theObject)
	Returns true if object refers to the same data model instance. More...

virtual void	colorConfigInfo (std::string &, std::string &, std::string &)
	Returns the parameters of color definition in the resources config manager. More...

virtual bool	isDisplayed ()
	Returns true if object must be displayed in the viewer: flag is stored in the data model, so on undo/redo, open/save or recreation of object by history-playing it keeps the original state in the current transaction. More...

virtual void	setDisplayed (const bool theDisplay)
	Sets the displayed/hidden state of the object. More...

virtual bool	hasTexture ()

virtual void	emptyFunction () const
	Empty function which is added for virtualiation of the interface. More...

Static Public Member Functions
static const std::string &	ID ()
	Offset macro feature kind. More...

static const std::string &	JOINT_ID ()
	Type of joint. More...

static const std::string &	JOINT_KEEP_DISTANCE ()
	Keep distance joint (add arcs where needed) More...

static const std::string &	JOINT_ARCS ()
	Arcs joint (make fillets on all straight lines intersections) More...

static const std::string &	JOINT_LINES ()
	Lines joint (do not add new arcs, prolongate and intersect adjacent lines) More...

static const std::string &	EDGES_ID ()
	list of offset edges More...

static const std::string &	VALUE_ID ()
	attribute to store the offset value More...

static const std::string &	REVERSED_ID ()
	attribute to store the reversed offset direction More...

static const std::string &	APPROX_ID ()
	attribute to approx by segments and arcs More...

static const std::string &	ADD_WIRE_ACTION_ID ()
	name for add wire action More...

static const std::string &	VALUE ()
	The value parameter for the constraint. More...

static const std::string &	FLYOUT_VALUE_PNT ()
	The 2D value parameter for the constraint. More...

static const std::string &	CONSTRAINT_ACTIVE ()
	State of constraint - Active - true, Suppressed - false. More...

static const std::string &	ENTITY_A ()
	First entity for the constraint. More...

static const std::string &	ENTITY_B ()
	Second entity for the constraint. More...

static const std::string &	ENTITY_C ()
	Third entity for the constraint. More...

static const std::string &	ENTITY_D ()
	Fourth entity for the constraint. More...

static const std::string &	ATTRIBUTE (const int theNumber)
	List of constraint attributes. More...

static std::string	group ()
	Returns the group identifier of all features. More...

static MODELAPI_EXPORT std::shared_ptr< ModelAPI_Feature >	feature (ObjectPtr theObject)
	Returns the feature by the object (result). More...

Protected Member Functions
virtual void	initAttributes ()
	Initializes attributes of derived class. More...

void	setSketch (SketchPlugin_Sketch *theSketch)
	Sets the higher-level feature for the sub-feature (sketch for line) More...

void	keepCurrentFeature ()
	Store current feature of the document if it is not the sub-feature of the current sketch. More...

void	restoreCurrentFeature ()
	Restore current feature of the document after adding new feature to the sketch. More...

virtual MODELAPI_EXPORT void	init ()
	This method is called just after creation of the object: it must initialize all fields, normally initialized in the constructor. More...

virtual void	setData (std::shared_ptr< ModelAPI_Data > theData)
	Sets the data manager of an object (document does) More...

virtual void	setDoc (std::shared_ptr< ModelAPI_Document > theDoc)
	Sets the data manager of an object (document does) More...

Detailed Description

Builds offset curves in the sketch.

Constructor & Destructor Documentation

◆ SketchPlugin_Offset()

SketchPlugin_Offset::SketchPlugin_Offset ( )

Use plugin manager for features creation.

Member Function Documentation

◆ ID()

static const std::string& SketchPlugin_Offset::ID ( )

inlinestatic

Offset macro feature kind.

◆ getKind()

virtual SKETCHPLUGIN_EXPORT const std::string& SketchPlugin_Offset::getKind ( )

inlinevirtual

Returns the kind of a feature.

Implements ModelAPI_Feature.

◆ JOINT_ID()

static const std::string& SketchPlugin_Offset::JOINT_ID ( )

inlinestatic

Type of joint.

◆ JOINT_KEEP_DISTANCE()

static const std::string& SketchPlugin_Offset::JOINT_KEEP_DISTANCE ( )

inlinestatic

Keep distance joint (add arcs where needed)

◆ JOINT_ARCS()

static const std::string& SketchPlugin_Offset::JOINT_ARCS ( )

inlinestatic

Arcs joint (make fillets on all straight lines intersections)

◆ JOINT_LINES()

static const std::string& SketchPlugin_Offset::JOINT_LINES ( )

inlinestatic

Lines joint (do not add new arcs, prolongate and intersect adjacent lines)

◆ EDGES_ID()

static const std::string& SketchPlugin_Offset::EDGES_ID ( )

inlinestatic

list of offset edges

◆ VALUE_ID()

static const std::string& SketchPlugin_Offset::VALUE_ID ( )

inlinestatic

attribute to store the offset value

◆ REVERSED_ID()

static const std::string& SketchPlugin_Offset::REVERSED_ID ( )

inlinestatic

attribute to store the reversed offset direction

◆ APPROX_ID()

static const std::string& SketchPlugin_Offset::APPROX_ID ( )

inlinestatic

attribute to approx by segments and arcs

◆ ADD_WIRE_ACTION_ID()

static const std::string& SketchPlugin_Offset::ADD_WIRE_ACTION_ID ( )

inlinestatic

name for add wire action

◆ attributeChanged()

void SketchPlugin_Offset::attributeChanged ( const std::string & theID )

virtual

Called on change of any argument-attribute of this object.

Reimplemented from ModelAPI_Object.

◆ execute()

void SketchPlugin_Offset::execute ( )

virtual

Creates a new part document if needed.

Implements ModelAPI_Feature.

◆ isPreviewNeeded()

virtual SKETCHPLUGIN_EXPORT bool SketchPlugin_Offset::isPreviewNeeded ( ) const

inlinevirtual

Returns true if preview update during the edition needed.

Otherwise the update-mechanism calls the execute function only on "apply" of the operation

Returns: true by default

Reimplemented from ModelAPI_Feature.

◆ customAction()

bool SketchPlugin_Offset::customAction ( const std::string & theActionId )

virtual

Find edges connected by coincident boundary constraint and composing a wire with the already selected segments.

It means that not more than 2 edges can be connected with the coincident point.

Parameters

[in] theActionId action key id (in following form: Action::Index)

Returns: false in case the action not performed.

Reimplemented from ModelAPI_Feature.

◆ getAISObject()

AISObjectPtr SketchPlugin_Offset::getAISObject ( AISObjectPtr thePrevious )

virtual

Returns the AIS preview.

Implements GeomAPI_IPresentable.

◆ initAttributes()

void SketchPlugin_Offset::initAttributes ( )

protectedvirtual

Initializes attributes of derived class.

Implements ModelAPI_Object.

◆ VALUE()

static const std::string& SketchPlugin_Constraint::VALUE ( )

inlinestaticinherited

The value parameter for the constraint.

◆ FLYOUT_VALUE_PNT()

static const std::string& SketchPlugin_Constraint::FLYOUT_VALUE_PNT ( )

inlinestaticinherited

The 2D value parameter for the constraint.

◆ CONSTRAINT_ACTIVE()

static const std::string& SketchPlugin_Constraint::CONSTRAINT_ACTIVE ( )

inlinestaticinherited

State of constraint - Active - true, Suppressed - false.

◆ ENTITY_A()

static const std::string& SketchPlugin_Constraint::ENTITY_A ( )

inlinestaticinherited

First entity for the constraint.

◆ ENTITY_B()

static const std::string& SketchPlugin_Constraint::ENTITY_B ( )

inlinestaticinherited

Second entity for the constraint.

◆ ENTITY_C()

static const std::string& SketchPlugin_Constraint::ENTITY_C ( )

inlinestaticinherited

Third entity for the constraint.

◆ ENTITY_D()

static const std::string& SketchPlugin_Constraint::ENTITY_D ( )

inlinestaticinherited

Fourth entity for the constraint.

◆ ATTRIBUTE()

static const std::string& SketchPlugin_Constraint::ATTRIBUTE ( const int theNumber )

inlinestaticinherited

List of constraint attributes.

◆ isZeroValueAllowed()

virtual bool SketchPlugin_Constraint::isZeroValueAllowed ( )

inlinevirtualinherited

Get if a constraint is able to have a zero numeric value.

Reimplemented in SketchPlugin_ConstraintLength.

◆ setNumericValue()

virtual void SketchPlugin_Constraint::setNumericValue ( const double theValue )

inlinevirtualinherited

Set numeric value to attribute VALUE()

Parameters

theValue new set value

Reimplemented in SketchPlugin_ConstraintDistanceAlongDir, and SketchPlugin_ConstraintAngle.

◆ getNumericValue()

virtual double SketchPlugin_Constraint::getNumericValue ( )

inlinevirtualinherited

Get numeric value of attribute VALUE()

Reimplemented in SketchPlugin_ConstraintDistanceAlongDir, and SketchPlugin_ConstraintAngle.

◆ isInHistory()

virtual bool SketchPlugin_Feature::isInHistory ( )

inlinevirtualinherited

Returns true if this feature must be displayed in the history (top level of Part tree)

Reimplemented from ModelAPI_Object.

◆ isExternal()

virtual bool SketchPlugin_Feature::isExternal ( ) const

inlinevirtualinherited

Returns true of the feature is created basing on the external shape of not-this-sketch object.

Reimplemented in SketchPlugin_SketchEntity.

◆ isCopy()

virtual bool SketchPlugin_Feature::isCopy ( ) const

inlinevirtualinherited

Returns true if the feature is a copy of other feature.

Reimplemented in SketchPlugin_SketchEntity.

◆ canBeDisplayed()

virtual bool SketchPlugin_Feature::canBeDisplayed ( ) const

inlinevirtualinherited

Returns true if the feature and the feature results can be displayed.

Returns: true

Reimplemented in SketchPlugin_Projection, and SketchPlugin_IntersectionPoint.

◆ isFixed()

virtual bool SketchPlugin_Feature::isFixed ( )

inlinevirtualinherited

Returns true is sketch element is under the rigid constraint.

Reimplemented in SketchPlugin_Projection, SketchPlugin_Point, SketchPlugin_Line, SketchPlugin_IntersectionPoint, SketchPlugin_EllipticArc, SketchPlugin_Ellipse, SketchPlugin_Circle, SketchPlugin_BSplineBase, and SketchPlugin_Arc.

◆ sketch()

SketchPlugin_Sketch * SketchPlugin_Feature::sketch ( )

inherited

Returns the sketch of this feature.

◆ setSketch()

void SketchPlugin_Feature::setSketch ( SketchPlugin_Sketch * theSketch )

inlineprotectedinherited

Sets the higher-level feature for the sub-feature (sketch for line)

◆ keepCurrentFeature()

void SketchPlugin_Feature::keepCurrentFeature ( )

protectedinherited

Store current feature of the document if it is not the sub-feature of the current sketch.

◆ restoreCurrentFeature()

void SketchPlugin_Feature::restoreCurrentFeature ( )

protectedinherited

Restore current feature of the document after adding new feature to the sketch.

◆ group()

static std::string ModelAPI_Feature::group ( )

inlinestaticinherited

Returns the group identifier of all features.

◆ document() [1/2]

virtual std::shared_ptr<ModelAPI_Document> ModelAPI_Feature::document ( ) const

inlinevirtualinherited

Returns document this feature belongs to.

Reimplemented from ModelAPI_Object.

◆ document() [2/2]

std::shared_ptr<ModelAPI_AttributeDocRef> ModelAPI_Feature::document ( const std::string & theID )

inlineinherited

Returns the document reference attribute.

◆ groupName()

virtual std::string ModelAPI_Feature::groupName ( )

inlinevirtualinherited

Returns the group identifier of this result.

Implements ModelAPI_Object.

◆ compute()

virtual bool ModelAPI_Feature::compute ( const std::string & )

inlinevirtualinherited

Computes the attribute value on the base of other attributes if the value can be computed.

Parameters

theAttributeId an attribute index to be computed

Returns: a boolean value about it is computed

Reimplemented in SketchPlugin_ConstraintRadius, SketchPlugin_ConstraintLength, and SketchPlugin_ConstraintAngle.

◆ setError()

void ModelAPI_Feature::setError	(	const std::string &	theError,
		bool	isSend = `true`,
		bool	isTranslate = `true`
	)

virtualinherited

Registers error during the execution, causes the ExecutionFailed state.

◆ error()

virtual std::string ModelAPI_Feature::error ( ) const

inlinevirtualinherited

Returns error, arose during the execution.

◆ results()

const std::list< std::shared_ptr< ModelAPI_Result > > & ModelAPI_Feature::results ( )

inherited

returns the current results of the feature

◆ firstResult()

std::shared_ptr< ModelAPI_Result > ModelAPI_Feature::firstResult ( ) const

inherited

returns the first result in the list or NULL reference

◆ lastResult()

std::shared_ptr< ModelAPI_Result > ModelAPI_Feature::lastResult ( )

inherited

returns the last result in the list or NULL reference

◆ setResult() [1/2]

void ModelAPI_Feature::setResult ( const std::shared_ptr< ModelAPI_Result > & theResult )

inherited

sets the alone result

◆ setResult() [2/2]

void ModelAPI_Feature::setResult	(	const std::shared_ptr< ModelAPI_Result > &	theResult,
		const int	theIndex
	)

inherited

sets the result by index (zero based), results before this must be set before

◆ removeResults()

void ModelAPI_Feature::removeResults	(	const int	theSinceIndex,
		const bool	theForever = `true`,
		const bool	theFlush = `true`
	)

inherited

removes all results starting from the given index (zero-based)

Parameters

theSinceIndex	- index of the deleted result and all after also will be deleted
theForever	- removes results for long period (not just because of feature disabling)
theFlush	- if it is false, REDISPLAY message is not flushed

◆ eraseResults()

void ModelAPI_Feature::eraseResults ( const bool theForever = true )

inherited

removes all results from the feature

◆ erase()

void ModelAPI_Feature::erase ( )

virtualinherited

removes all fields from this feature: results, data, etc

Reimplemented from ModelAPI_Object.

Reimplemented in SketchPlugin_MultiTranslation, SketchPlugin_MultiRotation, SketchPlugin_ConstraintMirror, PartSetPlugin_Part, and ModelAPI_CompositeFeature.

◆ eraseResultFromList()

void ModelAPI_Feature::eraseResultFromList ( const std::shared_ptr< ModelAPI_Result > & theResult )

inherited

removes the result from the list of feature (not doing in disabled): normally this method is not used from features.

only internally

◆ isPersistentResult()

virtual bool ModelAPI_Feature::isPersistentResult ( )

inlinevirtualinherited

Returns true if result is persistent (stored in document) and on undo-redo, save-open it is not needed to recompute it.

Reimplemented in ParametersPlugin_ParametersMgr, CollectionPlugin_GroupOperation, CollectionPlugin_Group, and CollectionPlugin_Field.

◆ isAction()

virtual bool ModelAPI_Feature::isAction ( )

inlinevirtualinherited

Returns true if this feature must not be created: this is just an action that is not stored in the features history and data model (like "delete part").

Reimplemented in PartSetPlugin_Remove, and PartSetPlugin_Duplicate.

◆ isMacro()

bool ModelAPI_Feature::isMacro ( ) const

virtualinherited

Returns true if this feature is used as macro: creates other features and then removed.

Returns: false by default

Reimplemented in SketchPlugin_Trim, SketchPlugin_Split, SketchPlugin_SketchDrawer, SketchPlugin_SketchCopy, SketchPlugin_Projection, SketchPlugin_MacroEllipticArc, SketchPlugin_MacroEllipse, SketchPlugin_MacroCircle, SketchPlugin_MacroBSpline, SketchPlugin_MacroArc, SketchPlugin_Fillet, SketchPlugin_CurveFitting, ParametersPlugin_ParametersMgr, FeaturesPlugin_SharedFaces, FeaturesPlugin_PointCoordinates, FeaturesPlugin_Measurement, FeaturesPlugin_InspectNormalToFace, FeaturesPlugin_InspectBoundingBox, FeaturesPlugin_GeometryCalculation, ExchangePlugin_ImportPart, ExchangePlugin_ImportBase, ExchangePlugin_ExportPart, ExchangePlugin_ExportFeature, and ExchangePlugin_Dump.

◆ documentToAdd()

const std::string & ModelAPI_Feature::documentToAdd ( )

virtualinherited

Must return document where the new feature must be added to By default it is empty: it is added to the document this method is called to.

Reimplemented in PartSetPlugin_Part.

◆ setDisabled()

bool ModelAPI_Feature::setDisabled ( const bool theFlag )

virtualinherited

Enables/disables the feature.

The disabled feature has no results and does not participate in any calculation.

Returns: true if state is really changed

◆ isDisabled()

bool ModelAPI_Feature::isDisabled ( )

virtualinherited

Returns the feature is disabled or not.

Implements ModelAPI_Object.

◆ feature()

FeaturePtr ModelAPI_Feature::feature ( ObjectPtr theObject )

staticinherited

Returns the feature by the object (result).

◆ setStable()

bool ModelAPI_Feature::setStable ( const bool theFlag )

virtualinherited

Set the stable feature flag.

If feature is currently editing then it is not stable.

Returns: true if state is really changed

◆ isStable()

bool ModelAPI_Feature::isStable ( )

virtualinherited

Returns the feature is stable or not.

◆ isEditable()

bool ModelAPI_Feature::isEditable ( )

virtualinherited

Returns the feature is editable or not. Most of features are editable.

Reimplemented in ExchangePlugin_ImportFeature.

◆ vertices()

ListOfShape ModelAPI_Feature::vertices ( const bool theOnlyUnique = false )

virtualinherited

Returns all the vertices produced by this feature.

◆ edges()

ListOfShape ModelAPI_Feature::edges ( const bool theOnlyUnique = false )

virtualinherited

Returns all the edges produced by this feature.

◆ wires()

ListOfShape ModelAPI_Feature::wires ( const bool theOnlyUnique = false )

virtualinherited

Returns all the wires produced by this feature.

◆ faces()

ListOfShape ModelAPI_Feature::faces ( const bool theOnlyUnique = false )

virtualinherited

Returns all the faces produced by this feature.

◆ shells()

ListOfShape ModelAPI_Feature::shells ( const bool theOnlyUnique = false )

virtualinherited

Returns all the shells produced by this feature.

◆ solids()

ListOfShape ModelAPI_Feature::solids ( const bool theOnlyUnique = false )

virtualinherited

Returns all the solids produced by this feature.

◆ name()

std::wstring ModelAPI_Feature::name ( )

inlineinherited

Returns the name stored in the attribute.

◆ boolean()

std::shared_ptr<ModelAPI_AttributeBoolean> ModelAPI_Feature::boolean ( const std::string & theID )

inlineinherited

Returns the Boolean attribute by the identifier.

◆ real()

std::shared_ptr<ModelAPI_AttributeDouble> ModelAPI_Feature::real ( const std::string & theID )

inlineinherited

Returns the real attribute by the identifier.

◆ integer()

std::shared_ptr<ModelAPI_AttributeInteger> ModelAPI_Feature::integer ( const std::string & theID )

inlineinherited

Returns the integer attribute by the identifier.

◆ intArray()

std::shared_ptr<ModelAPI_AttributeIntArray> ModelAPI_Feature::intArray ( const std::string & theID )

inlineinherited

Returns the integer array attribute by the identifier.

◆ refattr()

std::shared_ptr<ModelAPI_AttributeRefAttr> ModelAPI_Feature::refattr ( const std::string & theID )

inlineinherited

Returns the reference attribute by the identifier.

◆ refattrlist()

std::shared_ptr<ModelAPI_AttributeRefAttrList> ModelAPI_Feature::refattrlist ( const std::string & theID )

inlineinherited

Returns the refattrlist attribute by the identifier.

◆ reference()

std::shared_ptr<ModelAPI_AttributeReference> ModelAPI_Feature::reference ( const std::string & theID )

inlineinherited

Returns the reference attribute by the identifier.

◆ reflist()

std::shared_ptr<ModelAPI_AttributeRefList> ModelAPI_Feature::reflist ( const std::string & theID )

inlineinherited

Returns the list of references attribute by the identifier.

◆ selection()

std::shared_ptr<ModelAPI_AttributeSelection> ModelAPI_Feature::selection ( const std::string & theID )

inlineinherited

Returns the shape selection attribute by the identifier.

◆ selectionList()

std::shared_ptr<ModelAPI_AttributeSelectionList> ModelAPI_Feature::selectionList ( const std::string & theID )

inlineinherited

Returns the list of shape selections attribute by the identifier.

◆ string()

std::shared_ptr<ModelAPI_AttributeString> ModelAPI_Feature::string ( const std::string & theID )

inlineinherited

Returns the string attribute by the identifier.

◆ stringArray()

std::shared_ptr<ModelAPI_AttributeStringArray> ModelAPI_Feature::stringArray ( const std::string & theID )

inlineinherited

Returns the string array attribute by the identifier.

◆ tables()

std::shared_ptr<ModelAPI_AttributeTables> ModelAPI_Feature::tables ( const std::string & theID )

inlineinherited

Returns the tables attribute by the identifier.

◆ attribute()

std::shared_ptr<ModelAPI_Attribute> ModelAPI_Feature::attribute ( const std::string & theID )

inlineinherited

Returns the attribute by the identifier.

◆ init()

void ModelAPI_Feature::init ( )

protectedvirtualinherited

This method is called just after creation of the object: it must initialize all fields, normally initialized in the constructor.

Implements ModelAPI_Object.

◆ setInHistory()

void ModelAPI_Object::setInHistory	(	const std::shared_ptr< ModelAPI_Object >	theObject,
		const bool	theFlag
	)

virtualinherited

Makes object presented or not in the history of the created objects.

Parameters

theObject	is shared pointer to "this"
theFlag	is boolean value: to add or remove from the history

◆ data()

std::shared_ptr< ModelAPI_Data > ModelAPI_Object::data ( ) const

virtualinherited

Returns the data manager of this object: attributes.

◆ isSame()

bool ModelAPI_Object::isSame ( const std::shared_ptr< ModelAPI_Object > & theObject )

virtualinherited

Returns true if object refers to the same data model instance.

◆ colorConfigInfo()

virtual void ModelAPI_Object::colorConfigInfo	(	std::string &	,
		std::string &	,
		std::string &
	)

inlinevirtualinherited

Returns the parameters of color definition in the resources config manager.

Reimplemented in SketchPlugin_ConstraintRadius, SketchPlugin_ConstraintLength, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintAngle, Model_ResultPart, Model_ResultGroup, Model_ResultField, Model_ResultConstruction, and Model_ResultBody.

◆ isDisplayed()

bool ModelAPI_Object::isDisplayed ( )

virtualinherited

Returns true if object must be displayed in the viewer: flag is stored in the data model, so on undo/redo, open/save or recreation of object by history-playing it keeps the original state in the current transaction.

Reimplemented in ModelAPI_ResultField::ModelAPI_FieldStep.

◆ setDisplayed()

void ModelAPI_Object::setDisplayed ( const bool theDisplay )

virtualinherited

Sets the displayed/hidden state of the object.

If it is changed, sends the "redisplay" signal.

Reimplemented in ModelAPI_ResultField, ModelAPI_ResultField::ModelAPI_FieldStep, and ModelAPI_ResultBody.

◆ setData()

void ModelAPI_Object::setData ( std::shared_ptr< ModelAPI_Data > theData )

protectedvirtualinherited

Sets the data manager of an object (document does)

◆ setDoc()

void ModelAPI_Object::setDoc ( std::shared_ptr< ModelAPI_Document > theDoc )

protectedvirtualinherited

Sets the data manager of an object (document does)

◆ emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const

inlinevirtualinherited

Empty function which is added for virtualiation of the interface.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SketchPlugin_Offset()

Member Function Documentation

◆ ID()

◆ getKind()

◆ JOINT_ID()

◆ JOINT_KEEP_DISTANCE()

◆ JOINT_ARCS()

◆ JOINT_LINES()

◆ EDGES_ID()

◆ VALUE_ID()

◆ REVERSED_ID()

◆ APPROX_ID()

◆ ADD_WIRE_ACTION_ID()

◆ attributeChanged()

◆ execute()

◆ isPreviewNeeded()

◆ customAction()

◆ getAISObject()

◆ initAttributes()

◆ VALUE()

◆ FLYOUT_VALUE_PNT()

◆ CONSTRAINT_ACTIVE()

◆ ENTITY_A()

◆ ENTITY_B()

◆ ENTITY_C()

◆ ENTITY_D()

◆ ATTRIBUTE()

◆ isZeroValueAllowed()

◆ setNumericValue()

◆ getNumericValue()

◆ isInHistory()

◆ isExternal()

◆ isCopy()

◆ canBeDisplayed()

◆ isFixed()

◆ sketch()

◆ setSketch()

◆ keepCurrentFeature()

◆ restoreCurrentFeature()

◆ group()

◆ document() [1/2]

◆ document() [2/2]

◆ groupName()

◆ compute()

◆ setError()

◆ error()

◆ results()

◆ firstResult()

◆ lastResult()

◆ setResult() [1/2]

◆ setResult() [2/2]

◆ removeResults()

◆ eraseResults()

◆ erase()

◆ eraseResultFromList()

◆ isPersistentResult()

◆ isAction()

◆ isMacro()

◆ documentToAdd()

◆ setDisabled()

◆ isDisabled()

◆ feature()

◆ setStable()

◆ isStable()

◆ isEditable()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

◆ name()

◆ boolean()

◆ real()

◆ integer()