Interface for Plane feature. More...

Inheritance diagram for ConstructionAPI_Plane:

Public Member Functions
	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature)
	Constructor without values. More...

	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theFace, const ModelHighAPI_Double &theDistance, const bool theIsReverse, const ModelHighAPI_Integer &theNbCopy=ModelHighAPI_Integer(1))
	Constructor with values. More...

	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theA, const ModelHighAPI_Double &theB, const ModelHighAPI_Double &theC, const ModelHighAPI_Double &theD)
	Constructor with values. More...

	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &thePoint1, const ModelHighAPI_Selection &thePoint2, const ModelHighAPI_Selection &thePoint3)
	Constructor with values. More...

	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theLine, const ModelHighAPI_Selection &thePoint, const bool theIsPerpendicular)
	Constructor with values. More...

	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theObject1, const ModelHighAPI_Selection &theObject2)
	Constructor with values. More...

	ConstructionAPI_Plane (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &thePlane, const ModelHighAPI_Selection &theAxis, const ModelHighAPI_Double &theAngle, const ModelHighAPI_Integer &theNbCopy=ModelHighAPI_Integer(1))
	Constructor with values. More...

virtual	~ConstructionAPI_Plane ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< ModelAPI_AttributeString >	creationMethod () const
	Creation method. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	A () const
	Parameter A for general equation. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	B () const
	Parameter B for general equation. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	C () const
	Parameter C for general equation. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	D () const
	Parameter D for general equation. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	point1 () const
	Point 1 for plane. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	point2 () const
	Point 2 for plane. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	point3 () const
	Point 3 for plane. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	line () const
	Line for plane. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	point () const
	Point for plane. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	perpendicular () const
	Perpendicular flag. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	creationMethodByOtherPlane () const
	Creation method by other plane. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	plane () const
	Plane face. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	distance () const
	Distance. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	reverse () const
	Reverse flag. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	coincidentPoint () const
	Coincident point. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	axis () const
	Axis for rotation. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	angle () const
	Rotation angle. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	plane1 () const
	Plane 1. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	plane2 () const
	Plane 2. More...

virtual std::shared_ptr< ModelAPI_AttributeInteger >	nbcopy () const
	Number of copies. More...

void	setByFaceAndDistance (const ModelHighAPI_Selection &theFace, const ModelHighAPI_Double &theDistance, const bool theIsReverse, const ModelHighAPI_Integer &theNbCopy=ModelHighAPI_Integer(1))
	Set face and distance. More...

void	setByGeneralEquation (const ModelHighAPI_Double &theA, const ModelHighAPI_Double &theB, const ModelHighAPI_Double &theC, const ModelHighAPI_Double &theD)
	Set GeneralEquation parameters of the feature. More...

void	setByThreePoints (const ModelHighAPI_Selection &thePoint1, const ModelHighAPI_Selection &thePoint2, const ModelHighAPI_Selection &thePoint3)
	Set by three points. More...

void	setByLineAndPoint (const ModelHighAPI_Selection &theLine, const ModelHighAPI_Selection &thePoint, const bool theIsPerpendicular)
	Set by line and point. More...

void	setByTwoParallelPlanes (const ModelHighAPI_Selection &thePlane1, const ModelHighAPI_Selection &thePlane2)
	Set by two parallel planes. More...

void	setByCoincidentToPoint (const ModelHighAPI_Selection &thePlane, const ModelHighAPI_Selection &thePoint)
	Set by coincident to point. More...

void	setByRotation (const ModelHighAPI_Selection &thePlane, const ModelHighAPI_Selection &theAxis, const ModelHighAPI_Double &theAngle, const ModelHighAPI_Integer &theNbCopy=ModelHighAPI_Integer(1))
	Set by rotation. More...

virtual void	dump (ModelHighAPI_Dumper &theDumper) const
	Dump wrapped feature. More...

std::shared_ptr< ModelAPI_Feature >	feature () const
	Return ModelAPI_Feature. More...

std::shared_ptr< ModelHighAPI_Interface >	subFeature (const int theIndex) const
	If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index. More...

const std::string &	getKind () const
	Shortcut for feature()->getKind() More...

void	execute (bool isForce=false)
	Shortcut for feature()->execute() More...

void	setName (const std::wstring &theName)
	Shortcut for feature()->data()->setName() More...

std::wstring	name () const
	Shortcut for feature()->data()->name() More...

virtual ModelHighAPI_Selection	result () const
	Return firts object of the feature. More...

virtual std::list< ModelHighAPI_Selection >	results () const
	Return all objects of the feature. More...

virtual std::shared_ptr< ModelAPI_Result >	defaultResult () const
	Return default result. Default implementation feature()->lastResult() More...

void	throwException (const std::string &theDescription)
	Throw exception to event loop. More...

const std::string &	attributeGetter (const std::string &theAttrName)
	Return name of getter for specified attribute. More...

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

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

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

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

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

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

Static Public Member Functions
static std::string	ID ()

Protected Member Functions
bool	initialize ()

Protected Attributes
std::shared_ptr< ModelAPI_AttributeString >	mycreationMethod

std::shared_ptr< ModelAPI_AttributeDouble >	myA

std::shared_ptr< ModelAPI_AttributeDouble >	myB

std::shared_ptr< ModelAPI_AttributeDouble >	myC

std::shared_ptr< ModelAPI_AttributeDouble >	myD

std::shared_ptr< ModelAPI_AttributeSelection >	mypoint1

std::shared_ptr< ModelAPI_AttributeSelection >	mypoint2

std::shared_ptr< ModelAPI_AttributeSelection >	mypoint3

std::shared_ptr< ModelAPI_AttributeSelection >	myline

std::shared_ptr< ModelAPI_AttributeSelection >	mypoint

std::shared_ptr< ModelAPI_AttributeBoolean >	myperpendicular

std::shared_ptr< ModelAPI_AttributeString >	mycreationMethodByOtherPlane

std::shared_ptr< ModelAPI_AttributeSelection >	myplane

std::shared_ptr< ModelAPI_AttributeDouble >	mydistance

std::shared_ptr< ModelAPI_AttributeBoolean >	myreverse

std::shared_ptr< ModelAPI_AttributeSelection >	mycoincidentPoint

std::shared_ptr< ModelAPI_AttributeSelection >	myaxis

std::shared_ptr< ModelAPI_AttributeDouble >	myangle

std::shared_ptr< ModelAPI_AttributeSelection >	myplane1

std::shared_ptr< ModelAPI_AttributeSelection >	myplane2

std::shared_ptr< ModelAPI_AttributeInteger >	mynbcopy

std::shared_ptr< ModelAPI_Feature >	myFeature
	feature of this interface More...

std::map< std::string, std::string >	myAttrGetter
	names of attributes and their getters More...

Detailed Description

Interface for Plane feature.

Constructor & Destructor Documentation

◆ ConstructionAPI_Plane() [1/7]

ConstructionAPI_Plane::ConstructionAPI_Plane ( const std::shared_ptr< ModelAPI_Feature > & theFeature )

explicit

Constructor without values.

◆ ConstructionAPI_Plane() [2/7]

ConstructionAPI_Plane::ConstructionAPI_Plane	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theFace,
		const ModelHighAPI_Double &	theDistance,
		const bool	theIsReverse,
		const ModelHighAPI_Integer &	theNbCopy = `ModelHighAPI_Integer(1)`
	)

Constructor with values.

◆ ConstructionAPI_Plane() [3/7]

ConstructionAPI_Plane::ConstructionAPI_Plane	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Double &	theA,
		const ModelHighAPI_Double &	theB,
		const ModelHighAPI_Double &	theC,
		const ModelHighAPI_Double &	theD
	)

Constructor with values.

◆ ConstructionAPI_Plane() [4/7]

ConstructionAPI_Plane::ConstructionAPI_Plane	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	thePoint1,
		const ModelHighAPI_Selection &	thePoint2,
		const ModelHighAPI_Selection &	thePoint3
	)

Constructor with values.

◆ ConstructionAPI_Plane() [5/7]

ConstructionAPI_Plane::ConstructionAPI_Plane	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theLine,
		const ModelHighAPI_Selection &	thePoint,
		const bool	theIsPerpendicular
	)

Constructor with values.

◆ ConstructionAPI_Plane() [6/7]

ConstructionAPI_Plane::ConstructionAPI_Plane	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theObject1,
		const ModelHighAPI_Selection &	theObject2
	)

Constructor with values.

◆ ConstructionAPI_Plane() [7/7]

ConstructionAPI_Plane::ConstructionAPI_Plane	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	thePlane,
		const ModelHighAPI_Selection &	theAxis,
		const ModelHighAPI_Double &	theAngle,
		const ModelHighAPI_Integer &	theNbCopy = `ModelHighAPI_Integer(1)`
	)

Constructor with values.

◆ ~ConstructionAPI_Plane()

ConstructionAPI_Plane::~ConstructionAPI_Plane ( )

virtual

Destructor.

Member Function Documentation

◆ creationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Plane::creationMethod ( ) const

inlinevirtual

Creation method.

◆ A()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Plane::A ( ) const

inlinevirtual

Parameter A for general equation.

◆ B()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Plane::B ( ) const

inlinevirtual

Parameter B for general equation.

◆ C()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Plane::C ( ) const

inlinevirtual

Parameter C for general equation.

◆ D()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Plane::D ( ) const

inlinevirtual

Parameter D for general equation.

◆ point1()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::point1 ( ) const

inlinevirtual

Point 1 for plane.

◆ point2()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::point2 ( ) const

inlinevirtual

Point 2 for plane.

◆ point3()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::point3 ( ) const

inlinevirtual

Point 3 for plane.

◆ line()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::line ( ) const

inlinevirtual

Line for plane.

◆ point()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::point ( ) const

inlinevirtual

Point for plane.

◆ perpendicular()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > ConstructionAPI_Plane::perpendicular ( ) const

inlinevirtual

Perpendicular flag.

◆ creationMethodByOtherPlane()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Plane::creationMethodByOtherPlane ( ) const

inlinevirtual

Creation method by other plane.

◆ plane()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::plane ( ) const

inlinevirtual

Plane face.

◆ distance()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Plane::distance ( ) const

inlinevirtual

Distance.

◆ reverse()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > ConstructionAPI_Plane::reverse ( ) const

inlinevirtual

Reverse flag.

◆ coincidentPoint()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::coincidentPoint ( ) const

inlinevirtual

Coincident point.

◆ axis()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::axis ( ) const

inlinevirtual

Axis for rotation.

◆ angle()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Plane::angle ( ) const

inlinevirtual

Rotation angle.

◆ plane1()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::plane1 ( ) const

inlinevirtual

Plane 1.

◆ plane2()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Plane::plane2 ( ) const

inlinevirtual

Plane 2.

◆ nbcopy()

virtual std::shared_ptr< ModelAPI_AttributeInteger > ConstructionAPI_Plane::nbcopy ( ) const

inlinevirtual

Number of copies.

◆ setByFaceAndDistance()

void ConstructionAPI_Plane::setByFaceAndDistance	(	const ModelHighAPI_Selection &	theFace,
		const ModelHighAPI_Double &	theDistance,
		const bool	theIsReverse,
		const ModelHighAPI_Integer &	theNbCopy = `ModelHighAPI_Integer(1)`
	)

Set face and distance.

◆ setByGeneralEquation()

void ConstructionAPI_Plane::setByGeneralEquation	(	const ModelHighAPI_Double &	theA,
		const ModelHighAPI_Double &	theB,
		const ModelHighAPI_Double &	theC,
		const ModelHighAPI_Double &	theD
	)

Set GeneralEquation parameters of the feature.

◆ setByThreePoints()

void ConstructionAPI_Plane::setByThreePoints	(	const ModelHighAPI_Selection &	thePoint1,
		const ModelHighAPI_Selection &	thePoint2,
		const ModelHighAPI_Selection &	thePoint3
	)

Set by three points.

◆ setByLineAndPoint()

void ConstructionAPI_Plane::setByLineAndPoint	(	const ModelHighAPI_Selection &	theLine,
		const ModelHighAPI_Selection &	thePoint,
		const bool	theIsPerpendicular
	)

Set by line and point.

◆ setByTwoParallelPlanes()

void ConstructionAPI_Plane::setByTwoParallelPlanes	(	const ModelHighAPI_Selection &	thePlane1,
		const ModelHighAPI_Selection &	thePlane2
	)

Set by two parallel planes.

◆ setByCoincidentToPoint()

void ConstructionAPI_Plane::setByCoincidentToPoint	(	const ModelHighAPI_Selection &	thePlane,
		const ModelHighAPI_Selection &	thePoint
	)

Set by coincident to point.

◆ setByRotation()

void ConstructionAPI_Plane::setByRotation	(	const ModelHighAPI_Selection &	thePlane,
		const ModelHighAPI_Selection &	theAxis,
		const ModelHighAPI_Double &	theAngle,
		const ModelHighAPI_Integer &	theNbCopy = `ModelHighAPI_Integer(1)`
	)

Set by rotation.

◆ dump()

void ConstructionAPI_Plane::dump ( ModelHighAPI_Dumper & theDumper ) const

virtual

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ feature()

std::shared_ptr< ModelAPI_Feature > ModelHighAPI_Interface::feature ( ) const

inherited

Return ModelAPI_Feature.

◆ subFeature()

std::shared_ptr< ModelHighAPI_Interface > ModelHighAPI_Interface::subFeature ( const int theIndex ) const

inherited

If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index.

◆ getKind()

const std::string & ModelHighAPI_Interface::getKind ( ) const

inherited

Shortcut for feature()->getKind()

◆ execute()

void ModelHighAPI_Interface::execute ( bool isForce = false )

inherited

Shortcut for feature()->execute()

Parameters

isForce start execution of feature instead of sending events

◆ setName()

void ModelHighAPI_Interface::setName ( const std::wstring & theName )

inherited

Shortcut for feature()->data()->setName()

◆ name()

std::wstring ModelHighAPI_Interface::name ( ) const

inherited

Shortcut for feature()->data()->name()

◆ result()

ModelHighAPI_Selection ModelHighAPI_Interface::result ( ) const

virtualinherited

Return firts object of the feature.

◆ results()

std::list< ModelHighAPI_Selection > ModelHighAPI_Interface::results ( ) const

virtualinherited

Return all objects of the feature.

◆ defaultResult()

std::shared_ptr< ModelAPI_Result > ModelHighAPI_Interface::defaultResult ( ) const

virtualinherited

Return default result. Default implementation feature()->lastResult()

◆ throwException()

void ModelHighAPI_Interface::throwException ( const std::string & theDescription )

inherited

Throw exception to event loop.

◆ attributeGetter()

const std::string & ModelHighAPI_Interface::attributeGetter ( const std::string & theAttrName )

inherited

Return name of getter for specified attribute.

◆ vertices()

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

virtualinherited

Returns all the vertices produced by this feature.

◆ edges()

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

virtualinherited

Returns all the edges produced by this feature.

◆ wires()

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

virtualinherited

Returns all the wires produced by this feature.

◆ faces()

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

virtualinherited

Returns all the faces produced by this feature.

◆ shells()

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

virtualinherited

Returns all the shells produced by this feature.

◆ solids()

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

virtualinherited

Returns all the solids produced by this feature.

Field Documentation

◆ myFeature

std::shared_ptr<ModelAPI_Feature> ModelHighAPI_Interface::myFeature

protectedinherited

feature of this interface

◆ myAttrGetter

std::map<std::string, std::string> ModelHighAPI_Interface::myAttrGetter

protectedinherited

names of attributes and their getters

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConstructionAPI_Plane() [1/7]

◆ ConstructionAPI_Plane() [2/7]

◆ ConstructionAPI_Plane() [3/7]

◆ ConstructionAPI_Plane() [4/7]

◆ ConstructionAPI_Plane() [5/7]

◆ ConstructionAPI_Plane() [6/7]

◆ ConstructionAPI_Plane() [7/7]

◆ ~ConstructionAPI_Plane()

Member Function Documentation

◆ creationMethod()

◆ A()

◆ B()

◆ C()

◆ D()

◆ point1()

◆ point2()

◆ point3()

◆ line()

◆ point()

◆ perpendicular()

◆ creationMethodByOtherPlane()

◆ plane()

◆ distance()

◆ reverse()

◆ coincidentPoint()

◆ axis()

◆ angle()

◆ plane1()

◆ plane2()

◆ nbcopy()

◆ setByFaceAndDistance()

◆ setByGeneralEquation()

◆ setByThreePoints()

◆ setByLineAndPoint()

◆ setByTwoParallelPlanes()

◆ setByCoincidentToPoint()

◆ setByRotation()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter