Interface for primitive Box feature. More...

Inheritance diagram for PrimitivesAPI_Box:

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

	PrimitivesAPI_Box (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theDx, const ModelHighAPI_Double &theDy, const ModelHighAPI_Double &theDz)
	Constructor with values. More...

	PrimitivesAPI_Box (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theFirstPoint, const ModelHighAPI_Selection &theSecondPoint)
	Constructor with values. More...

	PrimitivesAPI_Box (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Double &theOx, const ModelHighAPI_Double &theOy, const ModelHighAPI_Double &theOz, const ModelHighAPI_Double &theHalfX, const ModelHighAPI_Double &theHalfY, const ModelHighAPI_Double &theHalfZ)
	Constructor with values. More...

virtual	~PrimitivesAPI_Box ()
	Destructor. More...

virtual std::string	getID ()

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

virtual std::shared_ptr< ModelAPI_AttributeDouble >	dx () const
	Dimension in X. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	dy () const
	Dimension in Y. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	dz () const
	Dimension in Z. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	firstPoint () const
	First point. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	secondPoint () const
	Second point. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	ox () const
	X coordinate for origin. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	oy () const
	Y coordinate for origin. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	oz () const
	Z coordinate for origin. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	halfdx () const
	Half length in X. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	halfdy () const
	Half length in Y. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	halfdz () const
	Half length in Z. More...

void	setDimensions (const ModelHighAPI_Double &theDx, const ModelHighAPI_Double &theDy, const ModelHighAPI_Double &theDz)
	Set dimensions. More...

void	setPoints (const ModelHighAPI_Selection &theFirstPoint, const ModelHighAPI_Selection &theSecondPoint)
	Set points. More...

void	setOrigin (const ModelHighAPI_Double &theOx, const ModelHighAPI_Double &theOy, const ModelHighAPI_Double &theOz)
	Set origin point. More...

void	setHalfLengths (const ModelHighAPI_Double &theHalfLengthX, const ModelHighAPI_Double &theHalfLengthY, const ModelHighAPI_Double &theHalfLengthZ)
	Set half lengths. 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 >	mydx

std::shared_ptr< ModelAPI_AttributeDouble >	mydy

std::shared_ptr< ModelAPI_AttributeDouble >	mydz

std::shared_ptr< ModelAPI_AttributeSelection >	myfirstPoint

std::shared_ptr< ModelAPI_AttributeSelection >	mysecondPoint

std::shared_ptr< ModelAPI_AttributeDouble >	myox

std::shared_ptr< ModelAPI_AttributeDouble >	myoy

std::shared_ptr< ModelAPI_AttributeDouble >	myoz

std::shared_ptr< ModelAPI_AttributeDouble >	myhalfdx

std::shared_ptr< ModelAPI_AttributeDouble >	myhalfdy

std::shared_ptr< ModelAPI_AttributeDouble >	myhalfdz

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 primitive Box feature.

Constructor & Destructor Documentation

◆ PrimitivesAPI_Box() [1/4]

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

explicit

Constructor without values.

◆ PrimitivesAPI_Box() [2/4]

PrimitivesAPI_Box::PrimitivesAPI_Box	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Double &	theDx,
		const ModelHighAPI_Double &	theDy,
		const ModelHighAPI_Double &	theDz
	)

explicit

Constructor with values.

◆ PrimitivesAPI_Box() [3/4]

PrimitivesAPI_Box::PrimitivesAPI_Box	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theFirstPoint,
		const ModelHighAPI_Selection &	theSecondPoint
	)

explicit

Constructor with values.

◆ PrimitivesAPI_Box() [4/4]

PrimitivesAPI_Box::PrimitivesAPI_Box	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Double &	theOx,
		const ModelHighAPI_Double &	theOy,
		const ModelHighAPI_Double &	theOz,
		const ModelHighAPI_Double &	theHalfX,
		const ModelHighAPI_Double &	theHalfY,
		const ModelHighAPI_Double &	theHalfZ
	)

explicit

Constructor with values.

◆ ~PrimitivesAPI_Box()

PrimitivesAPI_Box::~PrimitivesAPI_Box ( )

virtual

Destructor.

Member Function Documentation

◆ creationMethod()

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

inlinevirtual

Creation method.

◆ dx()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::dx ( ) const

inlinevirtual

Dimension in X.

◆ dy()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::dy ( ) const

inlinevirtual

Dimension in Y.

◆ dz()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::dz ( ) const

inlinevirtual

Dimension in Z.

◆ firstPoint()

virtual std::shared_ptr< ModelAPI_AttributeSelection > PrimitivesAPI_Box::firstPoint ( ) const

inlinevirtual

First point.

◆ secondPoint()

virtual std::shared_ptr< ModelAPI_AttributeSelection > PrimitivesAPI_Box::secondPoint ( ) const

inlinevirtual

Second point.

◆ ox()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::ox ( ) const

inlinevirtual

X coordinate for origin.

◆ oy()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::oy ( ) const

inlinevirtual

Y coordinate for origin.

◆ oz()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::oz ( ) const

inlinevirtual

Z coordinate for origin.

◆ halfdx()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::halfdx ( ) const

inlinevirtual

Half length in X.

◆ halfdy()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::halfdy ( ) const

inlinevirtual

Half length in Y.

◆ halfdz()

virtual std::shared_ptr< ModelAPI_AttributeDouble > PrimitivesAPI_Box::halfdz ( ) const

inlinevirtual

Half length in Z.

◆ setDimensions()

void PrimitivesAPI_Box::setDimensions	(	const ModelHighAPI_Double &	theDx,
		const ModelHighAPI_Double &	theDy,
		const ModelHighAPI_Double &	theDz
	)

Set dimensions.

◆ setPoints()

void PrimitivesAPI_Box::setPoints	(	const ModelHighAPI_Selection &	theFirstPoint,
		const ModelHighAPI_Selection &	theSecondPoint
	)

Set points.

◆ setOrigin()

void PrimitivesAPI_Box::setOrigin	(	const ModelHighAPI_Double &	theOx,
		const ModelHighAPI_Double &	theOy,
		const ModelHighAPI_Double &	theOz
	)

Set origin point.

◆ setHalfLengths()

void PrimitivesAPI_Box::setHalfLengths	(	const ModelHighAPI_Double &	theHalfLengthX,
		const ModelHighAPI_Double &	theHalfLengthY,
		const ModelHighAPI_Double &	theHalfLengthZ
	)

Set half lengths.

◆ dump()

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

◆ PrimitivesAPI_Box() [1/4]

◆ PrimitivesAPI_Box() [2/4]

◆ PrimitivesAPI_Box() [3/4]

◆ PrimitivesAPI_Box() [4/4]

◆ ~PrimitivesAPI_Box()

Member Function Documentation

◆ creationMethod()

◆ dx()

◆ dy()

◆ dz()

◆ firstPoint()

◆ secondPoint()

◆ ox()

◆ oy()

◆ oz()

◆ halfdx()

◆ halfdy()

◆ halfdz()

◆ setDimensions()

◆ setPoints()

◆ setOrigin()

◆ setHalfLengths()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter