2 #ifndef HYDROData_Channel_HeaderFile
3 #define HYDROData_Channel_HeaderFile
5 #include "HYDROData_ArtificialObject.h"
7 class Handle(HYDROData_Polyline3D);
8 class Handle(HYDROData_Profile);
10 DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
12 /**\class HYDROData_Channel
16 class HYDROData_Channel : public HYDROData_ArtificialObject
20 * Enumeration of tags corresponding to the persistent object parameters.
24 DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
30 DEFINE_STANDARD_RTTI(HYDROData_Channel);
33 * Returns the kind of this object. Must be redefined in all objects of known type.
35 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_CHANNEL;}
38 * Dump object to Python script representation.
40 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
43 * Returns the list of all reference objects of this object.
45 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
48 * Returns the top shape of the object.
50 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
53 * Returns the 3d shape of the object.
55 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
58 * Update the shape presentations of stream.
59 * Call this method whenever you made changes for channel data.
61 HYDRODATA_EXPORT virtual void Update();
64 * Returns default filling color for new channel.
66 HYDRODATA_EXPORT static QColor DefaultFillingColor();
69 * Returns default border color for new channel.
71 HYDRODATA_EXPORT static QColor DefaultBorderColor();
75 // Public methods to work with Channel
78 * Sets reference guide line object for channel.
80 HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
83 * Returns reference guide line object of channel.
85 HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
88 * Remove reference guide line object from channel.
90 HYDRODATA_EXPORT virtual void RemoveGuideLine();
94 * Sets reference profile object for channel.
96 HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
99 * Returns reference profile object of channel.
101 HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
104 * Remove reference profile object from channel.
106 HYDRODATA_EXPORT virtual void RemoveProfile();
112 * Returns default filling color for new object.
114 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
117 * Returns default border color for new object.
119 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
123 friend class HYDROData_Iterator;
126 * Creates new object in the internal data structure. Use higher level objects
127 * to create objects with real content.
129 HYDRODATA_EXPORT HYDROData_Channel();
132 * Destructs properties of the object and object itself, removes it from the document.
134 virtual HYDRODATA_EXPORT ~HYDROData_Channel();