SHAPER  9.12.0
SketchAPI_BSplinePeriodic Class Reference

Interface for BSplinePeriodic feature. More...

Inheritance diagram for SketchAPI_BSplinePeriodic:
Inheritance graph

Public Member Functions

 SketchAPI_BSplinePeriodic (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
virtual ~SketchAPI_BSplinePeriodic ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< GeomDataAPI_Point2DArraypoles () const
 B-spline poles. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleArrayweights () const
 B-spline weights. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleArrayknots () const
 B-spline knots. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntArraymultiplicities () const
 Knots multiplicities. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegerdegree () const
 B-spline degree. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DstartPoint () const
 First pole of B-spline. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DendPoint () const
 Last pole of B-spline. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionexternal () const
 External. More...
 
void setByDegreePolesAndWeights (const ModelHighAPI_Integer &theDegree, const std::list< std::shared_ptr< GeomAPI_Pnt2d > > &thePoles, const std::list< ModelHighAPI_Double > &theWeights)
 Set by poles and weights. More...
 
void setByParameters (const ModelHighAPI_Integer &theDegree, const std::list< std::shared_ptr< GeomAPI_Pnt2d > > &thePoles, const std::list< ModelHighAPI_Double > &theWeights, const std::list< ModelHighAPI_Double > &theKnots, const std::list< ModelHighAPI_Integer > &theMults)
 Initialize by full set of B-spline parameters. More...
 
void setByExternal (const ModelHighAPI_Selection &theExternal)
 Set by external. More...
 
std::list< std::shared_ptr< SketchAPI_SketchEntity > > controlPoles (const std::list< int > &regular=std::list< int >(), const std::list< int > &auxiliary=std::list< int >()) const
 Generate list of construction points coincident with B-spline poles. More...
 
std::list< std::shared_ptr< SketchAPI_SketchEntity > > controlPolygon (const std::list< int > &regular=std::list< int >(), const std::list< int > &auxiliary=std::list< int >()) const
 Generate control polygon for B-spline curve. More...
 
bool insertPole (const int theIndex, const std::shared_ptr< GeomAPI_Pnt2d > &theCoordinates, const ModelHighAPI_Double &theWeight=ModelHighAPI_Double(1.0))
 Insert new pole after the pole with the given index. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. More...
 
std::shared_ptr< ModelAPI_AttributeBooleanauxiliary () const
 Auxiliary. More...
 
void setAuxiliary (bool theAuxiliary)
 Set auxiliary. 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 ()
 
static std::list< std::shared_ptr< SketchAPI_SketchEntity > > wrap (const std::list< std::shared_ptr< ModelAPI_Feature > > &theFeatures)
 Convert list of features to list of appropriate wrappers. More...
 

Protected Member Functions

bool initialize ()
 
bool isCopy () const
 Check the entity is a copy of another feature. More...
 

Protected Attributes

std::shared_ptr< GeomDataAPI_Point2DArraymypoles
 
std::shared_ptr< ModelAPI_AttributeDoubleArraymyweights
 
std::shared_ptr< ModelAPI_AttributeDoubleArraymyknots
 
std::shared_ptr< ModelAPI_AttributeIntArraymymultiplicities
 
std::shared_ptr< ModelAPI_AttributeIntegermydegree
 
std::shared_ptr< GeomDataAPI_Point2DmystartPoint
 
std::shared_ptr< GeomDataAPI_Point2DmyendPoint
 
std::shared_ptr< ModelAPI_AttributeSelectionmyexternal
 
std::shared_ptr< ModelAPI_AttributeBooleanmyAuxiliary
 
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 BSplinePeriodic feature.

Constructor & Destructor Documentation

◆ SketchAPI_BSplinePeriodic()

SketchAPI_BSplinePeriodic::SketchAPI_BSplinePeriodic ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)
explicit

Constructor without values.

◆ ~SketchAPI_BSplinePeriodic()

virtual SketchAPI_BSplinePeriodic::~SketchAPI_BSplinePeriodic ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ poles()

virtual std::shared_ptr< GeomDataAPI_Point2DArray > SketchAPI_BSpline::poles ( ) const
inlinevirtualinherited

B-spline poles.

◆ weights()

virtual std::shared_ptr< ModelAPI_AttributeDoubleArray > SketchAPI_BSpline::weights ( ) const
inlinevirtualinherited

B-spline weights.

◆ knots()

virtual std::shared_ptr< ModelAPI_AttributeDoubleArray > SketchAPI_BSpline::knots ( ) const
inlinevirtualinherited

B-spline knots.

◆ multiplicities()

virtual std::shared_ptr< ModelAPI_AttributeIntArray > SketchAPI_BSpline::multiplicities ( ) const
inlinevirtualinherited

Knots multiplicities.

◆ degree()

virtual std::shared_ptr< ModelAPI_AttributeInteger > SketchAPI_BSpline::degree ( ) const
inlinevirtualinherited

B-spline degree.

◆ startPoint()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_BSpline::startPoint ( ) const
inlinevirtualinherited

First pole of B-spline.

◆ endPoint()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_BSpline::endPoint ( ) const
inlinevirtualinherited

Last pole of B-spline.

◆ external()

virtual std::shared_ptr< ModelAPI_AttributeSelection > SketchAPI_BSpline::external ( ) const
inlinevirtualinherited

External.

◆ setByDegreePolesAndWeights()

void SketchAPI_BSpline::setByDegreePolesAndWeights ( const ModelHighAPI_Integer theDegree,
const std::list< std::shared_ptr< GeomAPI_Pnt2d > > &  thePoles,
const std::list< ModelHighAPI_Double > &  theWeights 
)
inherited

Set by poles and weights.

◆ setByParameters()

void SketchAPI_BSpline::setByParameters ( const ModelHighAPI_Integer theDegree,
const std::list< std::shared_ptr< GeomAPI_Pnt2d > > &  thePoles,
const std::list< ModelHighAPI_Double > &  theWeights,
const std::list< ModelHighAPI_Double > &  theKnots,
const std::list< ModelHighAPI_Integer > &  theMults 
)
inherited

Initialize by full set of B-spline parameters.

◆ setByExternal()

void SketchAPI_BSpline::setByExternal ( const ModelHighAPI_Selection theExternal)
inherited

Set by external.

◆ controlPoles()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_BSpline::controlPoles ( const std::list< int > &  regular = std::list<int>(),
const std::list< int > &  auxiliary = std::list<int>() 
) const
inherited

Generate list of construction points coincident with B-spline poles.

◆ controlPolygon()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_BSpline::controlPolygon ( const std::list< int > &  regular = std::list<int>(),
const std::list< int > &  auxiliary = std::list<int>() 
) const
inherited

Generate control polygon for B-spline curve.

◆ insertPole()

bool SketchAPI_BSpline::insertPole ( const int  theIndex,
const std::shared_ptr< GeomAPI_Pnt2d > &  theCoordinates,
const ModelHighAPI_Double theWeight = ModelHighAPI_Double(1.0) 
)
inherited

Insert new pole after the pole with the given index.

◆ dump()

void SketchAPI_BSpline::dump ( ModelHighAPI_Dumper theDumper) const
virtualinherited

Dump wrapped feature.

Reimplemented from SketchAPI_SketchEntity.

◆ auxiliary()

std::shared_ptr< ModelAPI_AttributeBoolean > SketchAPI_SketchEntity::auxiliary ( ) const
inherited

Auxiliary.

◆ setAuxiliary()

void SketchAPI_SketchEntity::setAuxiliary ( bool  theAuxiliary)
inherited

Set auxiliary.

◆ wrap()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_SketchEntity::wrap ( const std::list< std::shared_ptr< ModelAPI_Feature > > &  theFeatures)
staticinherited

Convert list of features to list of appropriate wrappers.

◆ isCopy()

bool SketchAPI_SketchEntity::isCopy ( ) const
protectedinherited

Check the entity is a copy of another feature.

◆ 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