SHAPER  9.12.0
PrimitivesAPI_Sphere Class Reference

Interface for primitive Sphere feature. More...

Inheritance diagram for PrimitivesAPI_Sphere:
Inheritance graph

Public Member Functions

 PrimitivesAPI_Sphere (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 PrimitivesAPI_Sphere (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theCenterPoint, const ModelHighAPI_Double &theRadius)
 Constructor with values. More...
 
 PrimitivesAPI_Sphere (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theRMin, const ModelHighAPI_Double &theRMax, const ModelHighAPI_Double &thePhiMin, const ModelHighAPI_Double &thePhiMax, const ModelHighAPI_Double &theThetaMin, const ModelHighAPI_Double &theThetaMax)
 Constructor with values. More...
 
virtual ~PrimitivesAPI_Sphere ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeStringcreationMethod () const
 Creation method. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectioncenterPoint () const
 Center point. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleradius () const
 Radius. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublermin () const
 The minimum radius. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublermax () const
 The maximum radius. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublephimin () const
 The minimum phi. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublephimax () const
 The maximum phi. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublethetamin () const
 The minimum theta. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublethetamax () const
 The maximum theta. More...
 
void setCenterPoint (const ModelHighAPI_Selection &theCenterPoint)
 Set center point. More...
 
void setRadius (const ModelHighAPI_Double &theRadius)
 Set radius. More...
 
void setRadius (const ModelHighAPI_Double &theRMin, const ModelHighAPI_Double &theRMax)
 Set minimum and maximum radius. More...
 
void setPhi (const ModelHighAPI_Double &thePhiMin, const ModelHighAPI_Double &thePhiMax)
 Set minimum and maximum phi. More...
 
void setTheta (const ModelHighAPI_Double &theThetaMin, const ModelHighAPI_Double &theThetaMax)
 Set minimum and maximum theta. 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< ModelAPI_AttributeStringmycreationMethod
 
std::shared_ptr< ModelAPI_AttributeSelectionmycenterPoint
 
std::shared_ptr< ModelAPI_AttributeDoublemyradius
 
std::shared_ptr< ModelAPI_AttributeDoublemyrmin
 
std::shared_ptr< ModelAPI_AttributeDoublemyrmax
 
std::shared_ptr< ModelAPI_AttributeDoublemyphimin
 
std::shared_ptr< ModelAPI_AttributeDoublemyphimax
 
std::shared_ptr< ModelAPI_AttributeDoublemythetamin
 
std::shared_ptr< ModelAPI_AttributeDoublemythetamax
 
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 primitive Sphere feature.

Constructor & Destructor Documentation

◆ PrimitivesAPI_Sphere() [1/3]

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

Constructor without values.

◆ PrimitivesAPI_Sphere() [2/3]

PrimitivesAPI_Sphere::PrimitivesAPI_Sphere ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_Selection theCenterPoint,
const ModelHighAPI_Double theRadius 
)
explicit

Constructor with values.

◆ PrimitivesAPI_Sphere() [3/3]

PrimitivesAPI_Sphere::PrimitivesAPI_Sphere ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_Double theRMin,
const ModelHighAPI_Double theRMax,
const ModelHighAPI_Double thePhiMin,
const ModelHighAPI_Double thePhiMax,
const ModelHighAPI_Double theThetaMin,
const ModelHighAPI_Double theThetaMax 
)
explicit

Constructor with values.

◆ ~PrimitivesAPI_Sphere()

PrimitivesAPI_Sphere::~PrimitivesAPI_Sphere ( )
virtual

Destructor.

Member Function Documentation

◆ creationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > PrimitivesAPI_Sphere::creationMethod ( ) const
inlinevirtual

Creation method.

◆ centerPoint()

virtual std::shared_ptr< ModelAPI_AttributeSelection > PrimitivesAPI_Sphere::centerPoint ( ) const
inlinevirtual

Center point.

◆ radius()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::radius ( ) const
inlinevirtual

Radius.

◆ rmin()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::rmin ( ) const
inlinevirtual

The minimum radius.

◆ rmax()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::rmax ( ) const
inlinevirtual

The maximum radius.

◆ phimin()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::phimin ( ) const
inlinevirtual

The minimum phi.

◆ phimax()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::phimax ( ) const
inlinevirtual

The maximum phi.

◆ thetamin()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::thetamin ( ) const
inlinevirtual

The minimum theta.

◆ thetamax()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Sphere::thetamax ( ) const
inlinevirtual

The maximum theta.

◆ setCenterPoint()

void PrimitivesAPI_Sphere::setCenterPoint ( const ModelHighAPI_Selection theCenterPoint)

Set center point.

◆ setRadius() [1/2]

void PrimitivesAPI_Sphere::setRadius ( const ModelHighAPI_Double theRadius)

Set radius.

◆ setRadius() [2/2]

void PrimitivesAPI_Sphere::setRadius ( const ModelHighAPI_Double theRMin,
const ModelHighAPI_Double theRMax 
)

Set minimum and maximum radius.

◆ setPhi()

void PrimitivesAPI_Sphere::setPhi ( const ModelHighAPI_Double thePhiMin,
const ModelHighAPI_Double thePhiMax 
)

Set minimum and maximum phi.

◆ setTheta()

void PrimitivesAPI_Sphere::setTheta ( const ModelHighAPI_Double theThetaMin,
const ModelHighAPI_Double theThetaMax 
)

Set minimum and maximum theta.

◆ dump()

void PrimitivesAPI_Sphere::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