The construction element result of a feature. More...

Inheritance diagram for Model_ResultConstruction:

Public Member Functions
virtual void	colorConfigInfo (std::string &theSection, std::string &theName, std::string &theDefault)
	Retuns the parameters of color definition in the resources config manager. More...

virtual bool	isInHistory ()
	By default object is displayed in the object browser. More...

virtual void	setShape (std::shared_ptr< GeomAPI_Shape > theShape)
	Sets the result. More...

virtual std::shared_ptr< GeomAPI_Shape >	shape ()
	Returns the shape-result produced by this feature. More...

virtual void	setIsInHistory (const bool myIsInHistory)
	Sets the flag that it must be displayed in history (default is true) More...

virtual int	facesNum (const bool theUpdateNaming=true)
	if the construction result may be used as faces, this method returns not zero number of faces More...

virtual std::shared_ptr< GeomAPI_Face >	face (const int theIndex)
	if the construction result may be used as faces, this method returns face by zero based index More...

virtual void	setFacesOrder (const std::list< std::shared_ptr< GeomAPI_Face > > &theFaces)
	Change the order of faces. More...

virtual bool	isInfinite ()
	By default object is not infinite. More...

virtual void	setInfinite (const bool theInfinite)
	Sets the flag that it is infinite. More...

virtual void	setIsConcealed (const bool theValue, const bool theForced=false)
	The construction element may be concealed only by "delete" feature. More...

virtual bool	updateShape ()
	Updates the shape taking the current value from the data structure, returns true if update has been correctly done. More...

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

virtual bool	isConcealed ()
	Returns true if the result is concealed from 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 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 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 std::string	group ()
	Returns the group identifier of this result. More...

static const std::string &	DEFAULT_COLOR ()
	default color for a result construction More...

static const std::string &	RESULT_COLOR_NAME ()
	default color for a result construction More...

static const std::string	DEFAULT_DEFLECTION ()
	default deflection for a result construction 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_ResultConstruction ()
	Makes a body on the given feature. More...

void	storeShape (std::shared_ptr< GeomAPI_Shape > theShape)
	Stores shape in the data structure to allow identification it by the naming. 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 construction element result of a feature.

Provides a shape that may be displayed in the viewer. Intermediate, light result that in many cases produces a result on the fly.

Constructor & Destructor Documentation

◆ Model_ResultConstruction()

Model_ResultConstruction::Model_ResultConstruction ( )

protected

Makes a body on the given feature.

Member Function Documentation

◆ colorConfigInfo()

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

virtual

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

Reimplemented from ModelAPI_Object.

◆ isInHistory()

bool Model_ResultConstruction::isInHistory ( )

virtual

By default object is displayed in the object browser.

Reimplemented from ModelAPI_Object.

◆ setShape()

void Model_ResultConstruction::setShape ( std::shared_ptr< GeomAPI_Shape > theShape )

virtual

Sets the result.

Implements ModelAPI_ResultConstruction.

◆ shape()

std::shared_ptr< GeomAPI_Shape > Model_ResultConstruction::shape ( )

virtual

Returns the shape-result produced by this feature.

Reimplemented from ModelAPI_Result.

◆ setIsInHistory()

void Model_ResultConstruction::setIsInHistory ( const bool myIsInHistory )

virtual

Sets the flag that it must be displayed in history (default is true)

Implements ModelAPI_ResultConstruction.

◆ facesNum()

int Model_ResultConstruction::facesNum ( const bool theUpdateNaming = true )

virtual

if the construction result may be used as faces, this method returns not zero number of faces

Parameters

theUpdateNaming is false of keeping the naming structure untouched (on load)

Implements ModelAPI_ResultConstruction.

◆ face()

std::shared_ptr< GeomAPI_Face > Model_ResultConstruction::face ( const int theIndex )

virtual

if the construction result may be used as faces, this method returns face by zero based index

Implements ModelAPI_ResultConstruction.

◆ setFacesOrder()

void Model_ResultConstruction::setFacesOrder ( const std::list< std::shared_ptr< GeomAPI_Face > > & theFaces )

virtual

Change the order of faces.

Implements ModelAPI_ResultConstruction.

◆ isInfinite()

bool Model_ResultConstruction::isInfinite ( )

virtual

By default object is not infinite.

Implements ModelAPI_ResultConstruction.

◆ setInfinite()

void Model_ResultConstruction::setInfinite ( const bool theInfinite )

virtual

Sets the flag that it is infinite.

Implements ModelAPI_ResultConstruction.

◆ setIsConcealed()

void Model_ResultConstruction::setIsConcealed	(	const bool	theValue,
		const bool	theForced = `false`
	)

virtual

The construction element may be concealed only by "delete" feature.

Reimplemented from ModelAPI_Result.

◆ updateShape()

bool Model_ResultConstruction::updateShape ( )

virtual

Updates the shape taking the current value from the data structure, returns true if update has been correctly done.

Implements ModelAPI_ResultConstruction.

◆ storeShape()

void Model_ResultConstruction::storeShape ( std::shared_ptr< GeomAPI_Shape > theShape )

protected

Stores shape in the data structure to allow identification it by the naming.

◆ groupName()

std::string ModelAPI_ResultConstruction::groupName ( )

virtualinherited

Returns the group identifier of this result.

Implements ModelAPI_Object.

◆ group()

static std::string ModelAPI_ResultConstruction::group ( )

inlinestaticinherited

Returns the group identifier of this result.

◆ DEFAULT_COLOR()

static const std::string& ModelAPI_ResultConstruction::DEFAULT_COLOR ( )

inlinestaticinherited

default color for a result construction

◆ RESULT_COLOR_NAME()

static const std::string& ModelAPI_ResultConstruction::RESULT_COLOR_NAME ( )

inlinestaticinherited

default color for a result construction

◆ DEFAULT_DEFLECTION()

static const std::string ModelAPI_ResultConstruction::DEFAULT_DEFLECTION ( )

inlinestaticinherited

default deflection for a result construction

◆ 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