SHAPER  9.12.0
ConstructionAPI_Point Class Reference

Interface for Point feature. More...

Inheritance diagram for ConstructionAPI_Point:
Inheritance graph

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_Pointpoint () const
 Point attribute. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringcreationMethod () const
 Creation method. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringintersectionType () const
 Type of the intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionLine1 () const
 Line for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionLine2 () const
 Line for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionLine () const
 Line for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionPlane () const
 Plane for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionPlane1 () const
 Plane for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionPlane2 () const
 Plane for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionintersectionPlane3 () const
 Plane for intersection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringuseOffset () const
 Use offset. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleoffset () const
 Offset. More...
 
virtual std::shared_ptr< ModelAPI_AttributeBooleanreverseOffset () const
 Reverse offset. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionedge () const
 Edge. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringoffsetType () const
 Type of the offset on edge. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubledistance () const
 Distance. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleratio () const
 Ratio. More...
 
virtual std::shared_ptr< ModelAPI_AttributeBooleanreverse () const
 Reverse. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionpointToProject () const
 Point to project. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringprojectionType () const
 Type of the point projection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionfaceForPointProjection () const
 Face for point projection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionedgeForPointProjection () const
 Edge for point projection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringgeometricalPropertyType () const
 Type of the geometrical property. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionobjectForCenterOfGravity () const
 Object for center of gravity. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionobjectForCenterOfCircle () 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_Featurefeature () const
 Return ModelAPI_Feature. More...
 
std::shared_ptr< ModelHighAPI_InterfacesubFeature (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_Selectionresults () const
 Return all objects of the feature. More...
 
virtual std::shared_ptr< ModelAPI_ResultdefaultResult () 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...
 

Static Public Member Functions

static std::string ID ()
 

Protected Member Functions

bool initialize ()
 

Protected Attributes

std::shared_ptr< GeomDataAPI_Pointmypoint
 
std::shared_ptr< ModelAPI_AttributeStringmycreationMethod
 
std::shared_ptr< ModelAPI_AttributeStringmyintersectionType
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionLine1
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionLine2
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionLine
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionPlane
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionPlane1
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionPlane2
 
std::shared_ptr< ModelAPI_AttributeSelectionmyintersectionPlane3
 
std::shared_ptr< ModelAPI_AttributeStringmyuseOffset
 
std::shared_ptr< ModelAPI_AttributeDoublemyoffset
 
std::shared_ptr< ModelAPI_AttributeBooleanmyreverseOffset
 
std::shared_ptr< ModelAPI_AttributeSelectionmyedge
 
std::shared_ptr< ModelAPI_AttributeStringmyoffsetType
 
std::shared_ptr< ModelAPI_AttributeDoublemydistance
 
std::shared_ptr< ModelAPI_AttributeDoublemyratio
 
std::shared_ptr< ModelAPI_AttributeBooleanmyreverse
 
std::shared_ptr< ModelAPI_AttributeSelectionmypointToProject
 
std::shared_ptr< ModelAPI_AttributeStringmyprojectionType
 
std::shared_ptr< ModelAPI_AttributeSelectionmyfaceForPointProjection
 
std::shared_ptr< ModelAPI_AttributeSelectionmyedgeForPointProjection
 
std::shared_ptr< ModelAPI_AttributeStringmygeometricalPropertyType
 
std::shared_ptr< ModelAPI_AttributeSelectionmyobjectForCenterOfGravity
 
std::shared_ptr< ModelAPI_AttributeSelectionmyobjectForCenterOfCircle
 
std::shared_ptr< ModelAPI_FeaturemyFeature
 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

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

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