X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Channel.h;h=3e069097a2aab3e2dd6a101eaab2e4205f2a9f48;hb=a10433b0e4c819c3e85194f15b2bff87aa25df3f;hp=fbb35f4a1d2d15a9baf5ee8af9c2683bbcfc5573;hpb=7b9454f8053b968f127bf7981eb05b6749e261f4;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Channel.h b/src/HYDROData/HYDROData_Channel.h index fbb35f4a..3e069097 100644 --- a/src/HYDROData/HYDROData_Channel.h +++ b/src/HYDROData/HYDROData_Channel.h @@ -1,9 +1,34 @@ +// Copyright (C) 2014-2015 EDF-R&D +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef HYDROData_Channel_HeaderFile #define HYDROData_Channel_HeaderFile #include "HYDROData_ArtificialObject.h" +#include +#include + +class Handle(HYDROData_Polyline3D); +class Handle(HYDROData_Profile); +class TopTools_SequenceOfShape; +class TopTools_ListOfShape; + DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject) /**\class HYDROData_Channel @@ -12,6 +37,18 @@ DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject) */ class HYDROData_Channel : public HYDROData_ArtificialObject { +public: + + struct PrsDefinition + { + TopoDS_Shape myPrs3D; + TopoDS_Face myPrs2D; + TopoDS_Wire myLeftBank; + TopoDS_Wire myRightBank; + TopoDS_Wire myInlet; + TopoDS_Wire myOutlet; + }; + protected: /** * Enumeration of tags corresponding to the persistent object parameters. @@ -19,11 +56,27 @@ protected: enum DataTag { DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve + DataTag_GuideLine, + DataTag_Profile, + DataTag_EquiDistance, }; public: + DEFINE_STANDARD_RTTI(HYDROData_Channel); +public: + + /** + * Creates the presentations(2D and 3D) by given guide line and profile. + */ + HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine, + const Handle(HYDROData_Profile)& theProfile, + PrsDefinition& thePrs, + double theEquiDistance ); + +public: + /** * Returns the kind of this object. Must be redefined in all objects of known type. */ @@ -32,17 +85,89 @@ public: /** * Dump object to Python script representation. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath, + MapOfTreatedObjects& theTreatedObjects ) const; + + /** + * Returns the list of all reference objects of this object. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; + + /** + * Returns the left edge of the channel. + */ + HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const; /** - * Returns the top shape of the object. + * Returns the right edge of the channel. */ - HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const; + HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const; /** - * Returns the 3d shape of the object. + * Update the shape presentations of stream. + * Call this method whenever you made changes for channel data. + */ + HYDRODATA_EXPORT virtual void Update(); + + /** + * Checks that object has 2D presentation. Reimlemented to retun true. + */ + HYDRODATA_EXPORT virtual bool IsHas2dPrs() const; + + /** + * Returns default filling color for new channel. + */ + HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const; + + /** + * Returns default border color for new channel. + */ + HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const; + + +public: + // Public methods to work with Channel + + /** + * Sets reference guide line object for channel. + */ + HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine ); + + /** + * Returns reference guide line object of channel. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const; + + /** + * Remove reference guide line object from channel. + */ + HYDRODATA_EXPORT virtual void RemoveGuideLine(); + + + /** + * Sets reference profile object for channel. + */ + HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile ); + + /** + * Returns reference profile object of channel. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const; + + /** + * Remove reference profile object from channel. + */ + HYDRODATA_EXPORT virtual void RemoveProfile(); + + HYDRODATA_EXPORT void SetEquiDistance( double ); + HYDRODATA_EXPORT double GetEquiDistance() const; + +protected: + /** + * Returns the type of child altitude object. + * Reimplemented to create chanel altitude object. */ - HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const; + HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const; protected: