Part::Box Class Reference

#include <FeaturePartBox.h>

Inheritance diagram for Part::Box:

Public Member Functions
	Box ()
virtual Base::Type	getTypeId (void) const
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)
Public Attributes
App::PropertyLength	Height
App::PropertyLength	Length
App::PropertyLength	Width
Protected Member Functions
virtual const App::PropertyData &	getPropertyData (void) const
Static Protected Member Functions
static const App::PropertyData *	getPropertyDataPtr (void)
methods override feature

App::DocumentObjectExecReturn *	execute (void)
	recalculate the Feature
const char *	getViewProviderName (void) const
	returns the type name of the ViewProvider
short	mustExecute () const
	mustExecute We call this method to check if the object was modified to be invoked.
virtual void	onChanged (const App::Property *prop)
	get called by the container when a property has changed
void	Restore (Base::XMLReader &reader)
	This method was added for backward-compatibility.

Detailed Description

Definition at line 35 of file FeaturePartBox.h.

Constructor & Destructor Documentation

Box::Box ( )

Definition at line 42 of file FeaturePartBox.cpp.

References ADD_PROPERTY_TYPE, SketcherExample::f, Base::Length, and App::Prop_None.

Member Function Documentation

void * Part::Box::create ( void ) [static]

Reimplemented from Part::Primitive.

Definition at line 39 of file FeaturePartBox.cpp.

App::DocumentObjectExecReturn * Box::execute ( void ) [virtual]

recalculate the Feature

Implements Part::Primitive.

Definition at line 58 of file FeaturePartBox.cpp.

References App::PropertyFloat::getValue(), Height, Length, Part::PropertyPartShape::setValue(), Part::Feature::Shape, App::DocumentObject::StdReturn, and Width.

Base::Type Part::Box::getClassTypeId ( void ) [static]

Reimplemented from Part::Primitive.

Definition at line 39 of file FeaturePartBox.cpp.

const App::PropertyData & Part::Box::getPropertyData ( void ) const [protected, virtual]

Reimplemented from Part::Primitive.

Definition at line 39 of file FeaturePartBox.cpp.

const App::PropertyData * Part::Box::getPropertyDataPtr ( void ) [static, protected]

Reimplemented from Part::Primitive.

Definition at line 39 of file FeaturePartBox.cpp.

Base::Type Part::Box::getTypeId ( void ) const [virtual]

Reimplemented from Part::Primitive.

Definition at line 39 of file FeaturePartBox.cpp.

const char* Part::Box::getViewProviderName ( void ) const [inline, virtual]

returns the type name of the ViewProvider

Reimplemented from Part::Feature.

Definition at line 51 of file FeaturePartBox.h.

void Part::Box::init ( void ) [static]

Reimplemented from Part::Primitive.

Definition at line 39 of file FeaturePartBox.cpp.

Referenced by initPart().

short Box::mustExecute ( ) const [virtual]

mustExecute We call this method to check if the object was modified to be invoked.

If the object label or an argument is modified. If we must recompute the object - to call the method execute(). 0: no recompution is needed 1: recompution needed -1: the document examine all links of this object and if one is touched -> recompute

Reimplemented from Part::Primitive.

Definition at line 49 of file FeaturePartBox.cpp.

References Height, App::Property::isTouched(), Length, and Width.

void Box::onChanged ( const App::Property * prop ) [protected, virtual]

get called by the container when a property has changed

Reimplemented from Part::Primitive.

Definition at line 198 of file FeaturePartBox.cpp.

References Height, App::DocumentObject::isRestoring(), Length, App::DocumentObject::recompute(), Part::Feature::Shape, App::Property::StatusBits, and Width.

void Box::Restore ( Base::XMLReader & reader ) [protected, virtual]

This method was added for backward-compatibility.

In former versions of Box we had the properties x,y,z and l,h,w which have changed to Location -- as replacement for x,y and z and Length, Height and Width.

Reimplemented from App::PropertyContainer.

Definition at line 92 of file FeaturePartBox.cpp.

References SketcherExample::f, Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Base::Type::getName(), App::PropertyContainer::getPropertyByName(), App::Property::getTypeId(), App::PropertyVector::getValue(), App::PropertyFloat::getValue(), Height, RobotExample::l, Length, draftTools::p, App::GeoFeature::Placement, Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), Base::Persistence::Restore(), Base::Placement::setPosition(), Base::Placement::setRotation(), App::PropertyFloat::setValue(), App::PropertyVector::setValue(), Part::Feature::Shape, App::Property::StatusBits, RobotExample::w, Width, Base::Vector3< _Precision >::x, MovieTool::x, Base::Vector3< _Precision >::y, MovieTool::y, and Base::Vector3< _Precision >::z.