/** \class FeaturesPlugin_CompositeBoolean
* \ingroup Plugins
+ * \brief Interface for the composite boolean feature.
*/
class FeaturesPlugin_CompositeBoolean : public ModelAPI_CompositeFeature
{
ListOfShape& theResults,
std::list<std::shared_ptr<GeomAPI_Interface>>& theAlgos) = 0;
+ /// Results naming.
void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
const ListOfShape& theShells,
const GeomAlgoAPI_Boolean& theAlgo);
protected:
+ /// Type of boolean operation.
GeomAlgoAPI_Boolean::OperationType myBooleanOperationType;
};
/** \class FeaturesPlugin_CompositeSketch
* \ingroup Plugins
+ * \brief Interface for the composite sketch feature.
*/
class FeaturesPlugin_CompositeSketch : public ModelAPI_CompositeFeature
{
std::shared_ptr<GeomAlgoAPI_MakeShape>& theMakeShape,
std::shared_ptr<GeomAPI_DataMapOfShapeShape>& theDataMap) = 0;
+ /// Results naming.
void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
const std::shared_ptr<GeomAPI_Shape>& theResult,
/** \class FeaturesPlugin_ExtrusionBoolean
* \ingroup Plugins
+ * \brief Interface for the composite extrusion feature.
*/
class FeaturesPlugin_ExtrusionBoolean : public FeaturesPlugin_CompositeBoolean
{
/** \class FeaturesPlugin_ExtrusionCut
* \ingroup Plugins
+ * \brief This feature allows to create sketch, extrude faces from this sketch and
+ * cut result from other objects in a single operation.
*/
class FeaturesPlugin_ExtrusionCut : public FeaturesPlugin_ExtrusionBoolean
{
/** \class FeaturesPlugin_ExtrusionFuse
* \ingroup Plugins
+ * \brief This feature allows to create sketch, extrude faces from this sketch and
+ * fuse result with other objects in a single operation.
*/
class FeaturesPlugin_ExtrusionFuse : public FeaturesPlugin_ExtrusionBoolean
{
/** \class FeaturesPlugin_ExtrusionSketch
* \ingroup Plugins
+ * \brief This feature allows to create sketch and extrude faces from this sketch
+ * in a single operation.
*/
class FeaturesPlugin_ExtrusionSketch : public FeaturesPlugin_CompositeSketch
{
/** \class FeaturesPlugin_RevolutionBoolean
* \ingroup Plugins
+ * \brief Interface for the composite revolution feature.
*/
class FeaturesPlugin_RevolutionBoolean : public FeaturesPlugin_CompositeBoolean
{
/** \class FeaturesPlugin_RevolutionCut
* \ingroup Plugins
+ * \brief This feature allows to create sketch, revol faces from this sketch and
+ * cut result from other objects in a single operation.
*/
class FeaturesPlugin_RevolutionCut : public FeaturesPlugin_RevolutionBoolean
{
/** \class FeaturesPlugin_RevolutionFuse
* \ingroup Plugins
+ * \brief This feature allows to create sketch, revol faces from this sketch and
+ * fuse result with other objects in a single operation.
*/
class FeaturesPlugin_RevolutionFuse : public FeaturesPlugin_RevolutionBoolean
{
/** \class FeaturesPlugin_RevolutionSketch
* \ingroup Plugins
+ * \brief This feature allows to create sketch and revol faces from this sketch
+ * in a single operation.
*/
class FeaturesPlugin_RevolutionSketch : public FeaturesPlugin_CompositeSketch
{
#include "ModelAPI_AttributeValidator.h"
-/**
-* \ingroup Validators
-* A validator of selection
-*/
+/** \class FeaturesPlugin_ValidatorTransform
+ * \ingroup Validators
+ * \brief A validator of selection
+ */
class FeaturesPlugin_ValidatorTransform : public ModelAPI_AttributeValidator
{
public:
- //! returns true if attribute is valid
- //! \param theAttribute the checked attribute
- //! \param theArguments arguments of the attribute
+ /** \return true if attribute is valid
+ * \param theAttribute the checked attribute
+ * \param theArguments arguments of the attribute
+ * \param theError error message
+ */
virtual bool isValid(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
std::string& theError) const;
* at a distance less than the tolerance value. Return FALSE if the point
* is beyond the tolerance limit or if computation fails.
* Max Tolerance value is currently limited to 1.e-4
- * \param[in] theOrigin point of origin.
- * \param[in] theDir direction of axis.
+ * \param[in] thePoint point of origin.
+ * \param[in] theTolerance tolerance of computation.
+ * \param[out] theParameter resulting parameter.
*/
GEOMAPI_EXPORT const bool parameter(const std::shared_ptr<GeomAPI_Pnt> thePoint,
const double theTolerance,
#include "GeomAPI_AISObject.h"
#include <vector>
-/**
-* Interface of a class which can provide specific customization of
-* object presentation
-*/
+
class ModelAPI_Result;
+/** \class GeomAPI_ICustomPrs
+ * \ingroup DataModel
+ * \brief Interface of a class which can provide specific customization of
+ * object presentation
+ */
class GeomAPI_ICustomPrs
{
public:
/// Set working plane
/// \param theOrigin origin of the plane axis
/// \param theDirX X direction of the plane axis
- /// \param theDirY Y direction of the plane axis
/// \param theNorm normal direction of the plane axis
GEOMAPI_EXPORT void setPlane(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
const std::shared_ptr<GeomAPI_Dir>& theDirX,
/** \brief Constructs an explorer to search on theShape, for shapes of type toFind,
* that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE,
* or if it is the same as, or less complex than the shape toFind it has no effect on the search.
- \param[in] toFind shape type to find.
- \param[in] toAvoid shape type to avoid.
+ * \param[in] theShape shape to explore.
+ * \param[in] toFind shape type to find.
+ * \param[in] toAvoid shape type to avoid.
*/
GEOMAPI_EXPORT
GeomAPI_ShapeExplorer(const std::shared_ptr<GeomAPI_Shape>& theShape,
/** \brief Resets this explorer. It is initialized to search on theShape, for shapes of type toFind,
* that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE,
* or if it is the same as, or less complex than the shape toFind it has no effect on the search.
- \param[in] toFind shape type to find.
- \param[in] toAvoid shape type to avoid.
+ * \param[in] theShape shape to explore.
+ * \param[in] toFind shape type to find.
+ * \param[in] toAvoid shape type to avoid.
*/
GEOMAPI_EXPORT
void init(const std::shared_ptr<GeomAPI_Shape>& theShape,
class GeomAlgoAPI_Boolean : public GeomAPI_Interface
{
public:
+ /// Type of booelan operation
enum OperationType{
- BOOL_CUT,
- BOOL_FUSE,
- BOOL_COMMON
+ BOOL_CUT, ///< Cut objects
+ BOOL_FUSE, ///< Fuse objects
+ BOOL_COMMON ///< Take common part of objects
};
public:
GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(){};
protected:
- GeomAlgoAPI_MakeShape::AlgoType myAlgoType;
- std::shared_ptr<GeomAPI_Shape> myShape;
- std::shared_ptr<GeomAPI_Shape> myWire;
- std::shared_ptr<GeomAPI_Shape> myBaseShape;
+ GeomAlgoAPI_MakeShape::AlgoType myAlgoType; ///< Type of make shape algo.
+ std::shared_ptr<GeomAPI_Shape> myShape; ///< Resulting shape.
+ std::shared_ptr<GeomAPI_Shape> myWire; ///< Wire for pipe algo.
+ std::shared_ptr<GeomAPI_Shape> myBaseShape; ///< Base shape of algo.
};
typedef std::list<std::shared_ptr<GeomAlgoAPI_MakeShape> > ListOfMakeShape;
protected:
- ListOfMakeShape myListOfMakeShape;
+ ListOfMakeShape myListOfMakeShape; ///< List of make shape algos.
};
#endif
public:
/** \brief Creates revolution for the given shape.
* \param[in] theBasis face for revolution.
+ * \param[in] theAxis axis for revolution.
* \param[in] theToAngle to angle.
* \param[in] theFromAngle from angle.
*/
/** \brief Creates revolution for the given shape.
* \param[in] theBasis face for revolution.
+ * \param[in] theAxis axis for revolution.
* \param[in] theToShape to bounding shape. Can be empty. In this case offset will be applied to the basis.
* \param[in] theToAngle to angle.
* \param[in] theFromShape from bounding shape. Can be empty. In this case offset will be applied to the basis.
/** \class GeomAlgoAPI_ShapeTools
* \ingroup DataAlgo
- * \brief
+ * \brief Useful tools for working with shapes.
*/
class GEOMALGOAPI_EXPORT GeomAlgoAPI_ShapeTools
{
/** \brief Combines faces with common edges to shells, or solids to compsolids.
* \param[in] theCompound compound of shapes.
* \param[in] theType type of combine.
- * \param[out] theShells resulting shells.
- * \param[out] theFreeFaces faces that does not have common edges.
+ * \param[out] theCombinedShapes resulting shapes.
+ * \param[out] theFreeShapes shapes that does not have common subshapes.
*/
static void combineShapes(const std::shared_ptr<GeomAPI_Shape> theCompound,
const GeomAPI_Shape::ShapeType theType,
/** \brief Creates list of faces and unclosed wires on basis of the features of the sketch
* \param[in] theOrigin origin point of the sketch
* \param[in] theDirX x-direction of the sketch
- * \param[in] theDirY y-direction of the sketch
* \param[in] theNorm normal of the sketch
* \param[in] theFeatures initial features of the sketch
* \param[out] theResultFaces faces based on closed wires
/** \brief Creates list of faces and unclosed wires on basis of the features of the sketch
* \param[in] theOrigin origin point of the sketch
* \param[in] theDirX x-direction of the sketch
- * \param[in] theDirY y-direction of the sketch
* \param[in] theNorm normal of the sketch
* \param[in] theWire a wire which contains all edges
* \param[out] theResultFaces faces based on closed wires
namespace GeomAlgoAPI_Tools {
+/** \class Localizer
+ * \ingroup DataAlgo
+ * \brief Localizer tool.
+ */
class Localizer
{
public:
std::string myCurLocale;
};
+/** \class File_Tools
+ * \ingroup DataAlgo
+ * \brief File tool.
+ */
class File_Tools {
public:
/**
/** \brief Returns true if feature and/or attributes are valid.
* \param[in] theFeature the validated feature.
* \param[in] theArguments the arguments in the configuration file for this validator.
- * \returns true if feature is valid.
+ * \return true if feature is valid.
*/
GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
const std::list<std::string>& theArguments,