Interface for Point feature. More...

#include <ConstructionAPI_Point.h>

Inheritance diagram for ConstructionAPI_Point:

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

	ConstructionAPI_Point (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theX, const ModelHighAPI_Double &theY, const ModelHighAPI_Double &theZ)
	Constructor with values. More...

	ConstructionAPI_Point (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theEdge, const ModelHighAPI_Double &theOffset, const bool theUseRatio=false, const bool theReverse=false)
	Constructor with values. More...

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

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

	ConstructionAPI_Point (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theObject, const bool theIsCircularEdge=false, const bool theIsXYZSelection=false)
	Constructor with values: object and circular edge flag. More...

virtual	~ConstructionAPI_Point ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< GeomDataAPI_Point >	point () const
	Point attribute. More...

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

virtual std::shared_ptr< ModelAPI_AttributeString >	intersectionType () const
	Type of the intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionLine1 () const
	Line for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionLine2 () const
	Line for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionLine () const
	Line for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionPlane () const
	Plane for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionPlane1 () const
	Plane for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionPlane2 () const
	Plane for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	intersectionPlane3 () const
	Plane for intersection. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	useOffset () const
	Use offset. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	offset () const
	Offset. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	reverseOffset () const
	Reverse offset. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	edge () const
	Edge. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	offsetType () const
	Type of the offset on edge. More...

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

virtual std::shared_ptr< ModelAPI_AttributeDouble >	ratio () const
	Ratio. More...

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

virtual std::shared_ptr< ModelAPI_AttributeSelection >	pointToProject () const
	Point to project. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	projectionType () const
	Type of the point projection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	faceForPointProjection () const
	Face for point projection. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	edgeForPointProjection () const
	Edge for point projection. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	geometricalPropertyType () const
	Type of the geometrical property. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	objectForCenterOfGravity () const
	Object for center of gravity. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	objectForCenterOfCircle () const
	Object for center of circle. More...

void	setByXYZ (const ModelHighAPI_Double &theX, const ModelHighAPI_Double &theY, const ModelHighAPI_Double &theZ)
	Set point values. More...

void	setByOffsetOnEdge (const ModelHighAPI_Selection &theEdge, const ModelHighAPI_Double &theOffset, const bool theUseRatio=false, const bool theReverse=false)
	Set edge and distance on it for point. More...

void	setByProjectionOnEdge (const ModelHighAPI_Selection &theVertex, const ModelHighAPI_Selection &theEdge)
	Set point and edge for projection. More...

void	setByProjectionOnFace (const ModelHighAPI_Selection &theVertex, const ModelHighAPI_Selection &theFace)
	Set point and face for projection. More...

void	setByLinesIntersection (const ModelHighAPI_Selection &theEdge1, const ModelHighAPI_Selection &theEdge2)
	Set lines for intersections. More...

void	setByLineAndPlaneIntersection (const ModelHighAPI_Selection &theEdge, const ModelHighAPI_Selection &theFace)
	Set line and plane for intersections. More...

void	setByPlanesIntersection (const ModelHighAPI_Selection &theFace1, const ModelHighAPI_Selection &theFace2, const ModelHighAPI_Selection &theFace3)
	Set faces for intersections. More...

void	setByCenterOfGravity (const ModelHighAPI_Selection &theObject)
	Set object for center of gravity. More...

void	setByCenterOfCircle (const ModelHighAPI_Selection &theObject)
	Set object for center of circular edge. 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< GeomDataAPI_Point >	mypoint

std::shared_ptr< ModelAPI_AttributeString >	mycreationMethod

std::shared_ptr< ModelAPI_AttributeString >	myintersectionType

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionLine1

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionLine2

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionLine

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionPlane

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionPlane1

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionPlane2

std::shared_ptr< ModelAPI_AttributeSelection >	myintersectionPlane3

std::shared_ptr< ModelAPI_AttributeString >	myuseOffset

std::shared_ptr< ModelAPI_AttributeDouble >	myoffset

std::shared_ptr< ModelAPI_AttributeBoolean >	myreverseOffset

std::shared_ptr< ModelAPI_AttributeSelection >	myedge

std::shared_ptr< ModelAPI_AttributeString >	myoffsetType

std::shared_ptr< ModelAPI_AttributeDouble >	mydistance

std::shared_ptr< ModelAPI_AttributeDouble >	myratio

std::shared_ptr< ModelAPI_AttributeBoolean >	myreverse

std::shared_ptr< ModelAPI_AttributeSelection >	mypointToProject

std::shared_ptr< ModelAPI_AttributeString >	myprojectionType

std::shared_ptr< ModelAPI_AttributeSelection >	myfaceForPointProjection

std::shared_ptr< ModelAPI_AttributeSelection >	myedgeForPointProjection

std::shared_ptr< ModelAPI_AttributeString >	mygeometricalPropertyType

std::shared_ptr< ModelAPI_AttributeSelection >	myobjectForCenterOfGravity

std::shared_ptr< ModelAPI_AttributeSelection >	myobjectForCenterOfCircle

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 Point feature.

Constructor & Destructor Documentation

◆ ConstructionAPI_Point() [1/6]

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

explicit

Constructor without values.

◆ ConstructionAPI_Point() [2/6]

ConstructionAPI_Point::ConstructionAPI_Point	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Double &	theX,
		const ModelHighAPI_Double &	theY,
		const ModelHighAPI_Double &	theZ
	)

Constructor with values.

◆ ConstructionAPI_Point() [3/6]

ConstructionAPI_Point::ConstructionAPI_Point	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theEdge,
		const ModelHighAPI_Double &	theOffset,
		const bool	theUseRatio = `false`,
		const bool	theReverse = `false`
	)

Constructor with values.

◆ ConstructionAPI_Point() [4/6]

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

Constructor with values: intersected objects.

◆ ConstructionAPI_Point() [5/6]

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

Constructor with values: intersected objects.

◆ ConstructionAPI_Point() [6/6]

ConstructionAPI_Point::ConstructionAPI_Point	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theObject,
		const bool	theIsCircularEdge = `false`,
		const bool	theIsXYZSelection = `false`
	)

Constructor with values: object and circular edge flag.

May be used for creation of point by coordinates using selection-vertex.

◆ ~ConstructionAPI_Point()

ConstructionAPI_Point::~ConstructionAPI_Point ( )

virtual

Destructor.

Member Function Documentation

◆ point()

virtual std::shared_ptr< GeomDataAPI_Point > ConstructionAPI_Point::point ( ) const

inlinevirtual

Point attribute.

◆ creationMethod()

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

inlinevirtual

Creation method.

◆ intersectionType()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Point::intersectionType ( ) const

inlinevirtual

Type of the intersection.

◆ intersectionLine1()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionLine1 ( ) const

inlinevirtual

Line for intersection.

◆ intersectionLine2()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionLine2 ( ) const

inlinevirtual

Line for intersection.

◆ intersectionLine()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionLine ( ) const

inlinevirtual

Line for intersection.

◆ intersectionPlane()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionPlane ( ) const

inlinevirtual

Plane for intersection.

◆ intersectionPlane1()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionPlane1 ( ) const

inlinevirtual

Plane for intersection.

◆ intersectionPlane2()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionPlane2 ( ) const

inlinevirtual

Plane for intersection.

◆ intersectionPlane3()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::intersectionPlane3 ( ) const

inlinevirtual

Plane for intersection.

◆ useOffset()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Point::useOffset ( ) const

inlinevirtual

Use offset.

◆ offset()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Point::offset ( ) const

inlinevirtual

Offset.

◆ reverseOffset()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > ConstructionAPI_Point::reverseOffset ( ) const

inlinevirtual

Reverse offset.

◆ edge()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::edge ( ) const

inlinevirtual

Edge.

◆ offsetType()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Point::offsetType ( ) const

inlinevirtual

Type of the offset on edge.

◆ distance()

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

inlinevirtual

Distance.

◆ ratio()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ConstructionAPI_Point::ratio ( ) const

inlinevirtual

Ratio.

◆ reverse()

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

inlinevirtual

Reverse.

◆ pointToProject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::pointToProject ( ) const

inlinevirtual

Point to project.

◆ projectionType()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Point::projectionType ( ) const

inlinevirtual

Type of the point projection.

◆ faceForPointProjection()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::faceForPointProjection ( ) const

inlinevirtual

Face for point projection.

◆ edgeForPointProjection()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::edgeForPointProjection ( ) const

inlinevirtual

Edge for point projection.

◆ geometricalPropertyType()

virtual std::shared_ptr< ModelAPI_AttributeString > ConstructionAPI_Point::geometricalPropertyType ( ) const

inlinevirtual

Type of the geometrical property.

◆ objectForCenterOfGravity()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::objectForCenterOfGravity ( ) const

inlinevirtual

Object for center of gravity.

◆ objectForCenterOfCircle()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ConstructionAPI_Point::objectForCenterOfCircle ( ) const

inlinevirtual

Object for center of circle.

◆ setByXYZ()

void ConstructionAPI_Point::setByXYZ	(	const ModelHighAPI_Double &	theX,
		const ModelHighAPI_Double &	theY,
		const ModelHighAPI_Double &	theZ
	)

Set point values.

◆ setByOffsetOnEdge()

void ConstructionAPI_Point::setByOffsetOnEdge	(	const ModelHighAPI_Selection &	theEdge,
		const ModelHighAPI_Double &	theOffset,
		const bool	theUseRatio = `false`,
		const bool	theReverse = `false`
	)

Set edge and distance on it for point.

◆ setByProjectionOnEdge()

void ConstructionAPI_Point::setByProjectionOnEdge	(	const ModelHighAPI_Selection &	theVertex,
		const ModelHighAPI_Selection &	theEdge
	)

Set point and edge for projection.

◆ setByProjectionOnFace()

void ConstructionAPI_Point::setByProjectionOnFace	(	const ModelHighAPI_Selection &	theVertex,
		const ModelHighAPI_Selection &	theFace
	)

Set point and face for projection.

◆ setByLinesIntersection()

void ConstructionAPI_Point::setByLinesIntersection	(	const ModelHighAPI_Selection &	theEdge1,
		const ModelHighAPI_Selection &	theEdge2
	)

Set lines for intersections.

◆ setByLineAndPlaneIntersection()

void ConstructionAPI_Point::setByLineAndPlaneIntersection	(	const ModelHighAPI_Selection &	theEdge,
		const ModelHighAPI_Selection &	theFace
	)

Set line and plane for intersections.

◆ setByPlanesIntersection()

void ConstructionAPI_Point::setByPlanesIntersection	(	const ModelHighAPI_Selection &	theFace1,
		const ModelHighAPI_Selection &	theFace2,
		const ModelHighAPI_Selection &	theFace3
	)

Set faces for intersections.

◆ setByCenterOfGravity()

void ConstructionAPI_Point::setByCenterOfGravity ( const ModelHighAPI_Selection & theObject )

Set object for center of gravity.

◆ setByCenterOfCircle()

void ConstructionAPI_Point::setByCenterOfCircle ( const ModelHighAPI_Selection & theObject )

Set object for center of circular edge.

◆ dump()

void ConstructionAPI_Point::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_Point() [1/6]

◆ ConstructionAPI_Point() [2/6]

◆ ConstructionAPI_Point() [3/6]

◆ ConstructionAPI_Point() [4/6]

◆ ConstructionAPI_Point() [5/6]

◆ ConstructionAPI_Point() [6/6]

◆ ~ConstructionAPI_Point()

Member Function Documentation

◆ point()

◆ creationMethod()

◆ intersectionType()

◆ intersectionLine1()

◆ intersectionLine2()

◆ intersectionLine()

◆ intersectionPlane()

◆ intersectionPlane1()

◆ intersectionPlane2()

◆ intersectionPlane3()

◆ useOffset()

◆ offset()

◆ reverseOffset()

◆ edge()

◆ offsetType()

◆ distance()

◆ ratio()

◆ reverse()

◆ pointToProject()

◆ projectionType()

◆ faceForPointProjection()

◆ edgeForPointProjection()

◆ geometricalPropertyType()

◆ objectForCenterOfGravity()

◆ objectForCenterOfCircle()

◆ setByXYZ()

◆ setByOffsetOnEdge()

◆ setByProjectionOnEdge()

◆ setByProjectionOnFace()

◆ setByLinesIntersection()

◆ setByLineAndPlaneIntersection()

◆ setByPlanesIntersection()

◆ setByCenterOfGravity()

◆ setByCenterOfCircle()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter