SHAPER  9.12.0
Model_ResultField Class Reference

The fields result. More...

Inheritance diagram for Model_ResultField:
Inheritance graph

Data Structures

class  Model_FieldStep
 

Public Member Functions

virtual void colorConfigInfo (std::string &theSection, std::string &theName, std::string &theDefault)
 Returns the parameters of color definition in the resources configuration manager. More...
 
virtual std::shared_ptr< GeomAPI_Shapeshape ()
 Returns the compound of selected entities. More...
 
virtual int stepsSize () const
 Returns number of steps. More...
 
virtual std::string textLine (int theLine) const
 Returns a text line by its number. More...
 
virtual std::shared_ptr< ModelAPI_ResultField::ModelAPI_FieldStepstep (int theId) const
 Returns step object. More...
 
virtual ~Model_ResultField ()
 Removes the stored builders. More...
 
virtual void updateSteps ()
 To refresh the steps of a field. More...
 
virtual std::string groupName ()
 Returns the group identifier of this result. More...
 
virtual void setDisplayed (const bool theDisplay)
 Sets the displayed/hidden state of the object. More...
 
virtual bool isConcealed ()
 Returns true if the result is concealed from the data tree (referenced by other objects) More...
 
virtual void setIsConcealed (const bool theValue, const bool theForced=false)
 Sets the result as concealed in the data tree (referenced by other objects) More...
 
virtual bool setDisabled (std::shared_ptr< ModelAPI_Result > theThis, const bool theFlag)
 Enables/disables the result. More...
 
virtual bool isDisabled ()
 Returns the result is disabled or not. More...
 
virtual void initAttributes ()
 Request for initialization of data model of the result: adding all attributes. More...
 
virtual void attributeChanged (const std::string &theID)
 On change of attribute of the result update presentation of this result: for the current moment there are only presentation attributes assigned to results. 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_Datadata () 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_Documentdocument () const
 Returns document this feature belongs to. 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 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...
 
static const std::string & DEFAULT_COLOR ()
 default color for a result body More...
 
static const std::string & COLOR_ID ()
 Reference to the color of the result. More...
 
static const std::string & DEFLECTION_ID ()
 Reference to the deflection of the result. More...
 
static const std::string & TRANSPARENCY_ID ()
 Reference to the transparency of the result. More...
 
static const std::string & ISO_LINES_ID ()
 Reference to the transparency of the result. More...
 
static const std::string & SHOW_ISO_LINES_ID ()
 Reference to the transparency of the result. More...
 
static const std::string & SHOW_EDGES_DIRECTION_ID ()
 Reference to the transparency of the result. More...
 
static const std::string & BRING_TO_FRONT_ID ()
 Reference to the BringToFront flag of the result. More...
 

Protected Member Functions

 Model_ResultField (std::shared_ptr< ModelAPI_Data > theOwnerData)
 Makes a body on the given feature data. More...
 
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...
 

Protected Attributes

bool myIsDisabled
 the result is disabled: removed for the user, but keeps the general info More...
 

Friends

class Model_Objects
 

Detailed Description

The fields result.

Provides a compound of selected elements, without storage, one the fly.

Constructor & Destructor Documentation

◆ ~Model_ResultField()

Model_ResultField::~Model_ResultField ( )
virtual

Removes the stored builders.

◆ Model_ResultField()

Model_ResultField::Model_ResultField ( std::shared_ptr< ModelAPI_Data theOwnerData)
protected

Makes a body on the given feature data.

Member Function Documentation

◆ colorConfigInfo()

void Model_ResultField::colorConfigInfo ( std::string &  theSection,
std::string &  theName,
std::string &  theDefault 
)
virtual

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

Reimplemented from ModelAPI_Object.

◆ shape()

std::shared_ptr< GeomAPI_Shape > Model_ResultField::shape ( )
virtual

Returns the compound of selected entities.

Reimplemented from ModelAPI_Result.

◆ stepsSize()

int Model_ResultField::stepsSize ( ) const
virtual

Returns number of steps.

Implements ModelAPI_ResultField.

◆ textLine()

std::string Model_ResultField::textLine ( int  theLine) const
virtual

Returns a text line by its number.

Parameters
theLinea number of line

Implements ModelAPI_ResultField.

◆ step()

std::shared_ptr< ModelAPI_ResultField::ModelAPI_FieldStep > Model_ResultField::step ( int  theId) const
virtual

Returns step object.

Parameters
theIdan id of the object

Implements ModelAPI_ResultField.

◆ updateSteps()

void Model_ResultField::updateSteps ( )
virtual

To refresh the steps of a field.

Implements ModelAPI_ResultField.

◆ groupName()

std::string ModelAPI_ResultField::groupName ( )
virtualinherited

Returns the group identifier of this result.

Implements ModelAPI_Object.

◆ group()

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

Returns the group identifier of this result.

◆ DEFAULT_COLOR()

static const std::string& ModelAPI_ResultField::DEFAULT_COLOR ( )
inlinestaticinherited

default color for a result body

◆ setDisplayed()

void ModelAPI_ResultField::setDisplayed ( const bool  theDisplay)
virtualinherited

Sets the displayed/hidden state of the object.

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

Reimplemented from ModelAPI_Object.

◆ COLOR_ID()

static const std::string& ModelAPI_Result::COLOR_ID ( )
inlinestaticinherited

Reference to the color of the result.

The integer array is used. It contains three values for red, green and blue values. The values are in [0, 255] range

◆ DEFLECTION_ID()

static const std::string& ModelAPI_Result::DEFLECTION_ID ( )
inlinestaticinherited

Reference to the deflection of the result.

The double value is used. The value is in [0, 1] range

◆ TRANSPARENCY_ID()

static const std::string& ModelAPI_Result::TRANSPARENCY_ID ( )
inlinestaticinherited

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

◆ ISO_LINES_ID()

static const std::string& ModelAPI_Result::ISO_LINES_ID ( )
inlinestaticinherited

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

◆ SHOW_ISO_LINES_ID()

static const std::string& ModelAPI_Result::SHOW_ISO_LINES_ID ( )
inlinestaticinherited

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

◆ SHOW_EDGES_DIRECTION_ID()

static const std::string& ModelAPI_Result::SHOW_EDGES_DIRECTION_ID ( )
inlinestaticinherited

Reference to the transparency of the result.

The double value is used. The value is in [0, 1] range

◆ BRING_TO_FRONT_ID()

static const std::string& ModelAPI_Result::BRING_TO_FRONT_ID ( )
inlinestaticinherited

Reference to the BringToFront flag of the result.

The bool value is used.

◆ isConcealed()

bool ModelAPI_Result::isConcealed ( )
virtualinherited

Returns true if the result is concealed from the data tree (referenced by other objects)

Reimplemented in Model_ResultBody.

◆ setIsConcealed()

void ModelAPI_Result::setIsConcealed ( const bool  theValue,
const bool  theForced = false 
)
virtualinherited

Sets the result as concealed in the data tree (referenced by other objects)

Reimplemented in Model_ResultConstruction, and Model_ResultBody.

◆ setDisabled()

bool ModelAPI_Result::setDisabled ( std::shared_ptr< ModelAPI_Result theThis,
const bool  theFlag 
)
virtualinherited

Enables/disables the result.

The disabled result does not participate in any calculation and visualization: like it was removed. But it keeps the general parameters: colors, visibility, etc.

Parameters
theThispointer to this object, needed to generate all events if it is necessary
theFlagmakes disabled if it is true
Returns
true if state is really changed

Reimplemented in Model_ResultPart, and Model_ResultBody.

◆ isDisabled()

bool ModelAPI_Result::isDisabled ( )
virtualinherited

Returns the result is disabled or not.

Implements ModelAPI_Object.

◆ initAttributes()

void ModelAPI_Result::initAttributes ( )
virtualinherited

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

Implements ModelAPI_Object.

Reimplemented in ModelAPI_ResultParameter, Model_ResultPart, Model_ResultParameter, and Model_ResultBody.

◆ attributeChanged()

void ModelAPI_Result::attributeChanged ( const std::string &  theID)
virtualinherited

On change of attribute of the result update presentation of this result: for the current moment there are only presentation attributes assigned to results.

Reimplemented from ModelAPI_Object.

◆ init()

void ModelAPI_Result::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.

◆ isInHistory()

bool ModelAPI_Object::isInHistory ( )
virtualinherited

◆ 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
theObjectis shared pointer to "this"
theFlagis 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 ModelAPI_Feature, and Model_ResultField::Model_FieldStep.

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

◆ 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

◆ emptyFunction()

virtual void ModelAPI_Entity::emptyFunction ( ) const
inlinevirtualinherited

Empty function which is added for virtualiation of the interface.

Field Documentation

◆ myIsDisabled

bool ModelAPI_Result::myIsDisabled
protectedinherited

the result is disabled: removed for the user, but keeps the general info