Inheritance diagram for ModelAPI_ResultField::ModelAPI_FieldStep:

Public Member Functions
virtual ModelAPI_ResultField *	field () const =0

virtual int	id () const =0

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

virtual void	initAttributes ()
	Request for initialization of data model of the object: adding all attributes. More...

virtual bool	isDisabled ()
	Returns the feature is disabled or not. 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 std::wstring	name ()=0
	Returns a GUI name of this step. More...

virtual bool	isInHistory ()
	By default object is displayed in the object browser. 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 std::shared_ptr< ModelAPI_Document >	document () const
	Returns document this feature belongs to. More...

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

virtual void	attributeChanged (const std::string &theID)
	Called on change of any argument-attribute of this 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 std::string	group ()
	Returns the group identifier of this result. More...

Protected Member Functions
virtual 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...

virtual void	erase ()
	removes all fields from this feature More...

Member Function Documentation

◆ group()

static std::string ModelAPI_ResultField::ModelAPI_FieldStep::group ( )

inlinestatic

Returns the group identifier of this result.

◆ groupName()

virtual std::string ModelAPI_ResultField::ModelAPI_FieldStep::groupName ( )

inlinevirtual

Returns the group identifier of this object.

Implements ModelAPI_Object.

◆ initAttributes()

virtual void ModelAPI_ResultField::ModelAPI_FieldStep::initAttributes ( )

inlinevirtual

Request for initialization of data model of the object: adding all attributes.

Implements ModelAPI_Object.

◆ isDisabled()

virtual bool ModelAPI_ResultField::ModelAPI_FieldStep::isDisabled ( )

inlinevirtual

Returns the feature is disabled or not.

Implements ModelAPI_Object.

◆ isDisplayed()

virtual bool ModelAPI_ResultField::ModelAPI_FieldStep::isDisplayed ( )

inlinevirtual

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 from ModelAPI_Object.

◆ setDisplayed()

void ModelAPI_ResultField::ModelAPI_FieldStep::setDisplayed ( const bool theDisplay )

virtual

Sets the displayed/hidden state of the object.

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

Reimplemented from ModelAPI_Object.

◆ name()

virtual std::wstring ModelAPI_ResultField::ModelAPI_FieldStep::name ( )

pure virtual

Returns a GUI name of this step.

Implemented in Model_ResultField::Model_FieldStep.

◆ init()

virtual void ModelAPI_ResultField::ModelAPI_FieldStep::init ( )

inlineprotectedvirtual

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

Implements ModelAPI_Object.

◆ isInHistory()

bool ModelAPI_Object::isInHistory ( )

virtualinherited

By default object is displayed in the object browser.

Reimplemented in ExchangePlugin_ExportFeature, ExchangePlugin_ExportPart, FeaturesPlugin_RemoveResults, FiltersPlugin_Selection, Model_ResultConstruction, ParametersPlugin_Parameter, ParametersPlugin_ParametersMgr, SketchPlugin_Feature, and SketchPlugin_Sketch.

◆ 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.

◆ document()

std::shared_ptr< ModelAPI_Document > ModelAPI_Object::document ( ) const

virtualinherited

Returns document this feature belongs to.

Reimplemented in Model_ResultField::Model_FieldStep, and ModelAPI_Feature.

◆ 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 Model_ResultBody, Model_ResultConstruction, Model_ResultField, Model_ResultGroup, Model_ResultPart, SketchPlugin_ConstraintAngle, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintLength, and SketchPlugin_ConstraintRadius.

◆ attributeChanged()

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

virtualinherited

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

Parameters

theID identifier of changed attribute

Reimplemented in BuildPlugin_Filling, BuildPlugin_Interpolation, BuildPlugin_SubShapes, ExchangePlugin_ExportFeature, ExchangePlugin_ImportPart, FeaturesPlugin_BoundingBox, FeaturesPlugin_Fillet1D, FeaturesPlugin_GeometryCalculation, FeaturesPlugin_GroupSharedFaces, FeaturesPlugin_InspectBoundingBox, FeaturesPlugin_InspectNormalToFace, FeaturesPlugin_Measurement, FeaturesPlugin_NormalToFace, FeaturesPlugin_PointCloudOnFace, FeaturesPlugin_PointCoordinates, FeaturesPlugin_Recover, FeaturesPlugin_RemoveSubShapes, FeaturesPlugin_SharedFaces, FeaturesPlugin_Thickness, ModelAPI_Result, ParametersPlugin_Parameter, SketchPlugin_Arc, SketchPlugin_BSpline, SketchPlugin_BSplineBase, SketchPlugin_Circle, SketchPlugin_ConstraintAngle, SketchPlugin_ConstraintDistance, SketchPlugin_ConstraintDistanceAlongDir, SketchPlugin_ConstraintLength, SketchPlugin_ConstraintMiddle, SketchPlugin_ConstraintMirror, SketchPlugin_ConstraintRadius, SketchPlugin_Ellipse, SketchPlugin_EllipticArc, SketchPlugin_IntersectionPoint, SketchPlugin_Line, SketchPlugin_MacroArc, SketchPlugin_MacroCircle, SketchPlugin_MacroEllipse, SketchPlugin_MacroEllipticArc, SketchPlugin_MultiRotation, SketchPlugin_MultiTranslation, SketchPlugin_Offset, SketchPlugin_Point, SketchPlugin_Projection, SketchPlugin_Sketch, ExchangePlugin_Import, ExchangePlugin_Import_Image, and ExchangePlugin_ImportBase.

◆ hasTexture()

virtual bool ModelAPI_Object::hasTexture ( )

inlinevirtualinherited

Reimplemented in Model_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)

◆ erase()

void ModelAPI_Object::erase ( )

protectedvirtualinherited

removes all fields from this feature

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

◆ 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

Member Function Documentation

◆ group()

◆ groupName()

◆ initAttributes()

◆ isDisabled()

◆ isDisplayed()

◆ setDisplayed()

◆ name()

◆ init()

◆ isInHistory()

◆ setInHistory()

◆ data()

◆ isSame()

◆ document()

◆ colorConfigInfo()

◆ attributeChanged()

◆ hasTexture()

◆ setData()

◆ setDoc()

◆ erase()

◆ emptyFunction()