include/opencascade/IGESDraw_SegmentedViewsVisible.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( TCD )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESDraw_SegmentedViewsVisible_HeaderFile
0018 #define _IGESDraw_SegmentedViewsVisible_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESDraw_HArray1OfViewKindEntity.hxx>
0023 #include <TColStd_HArray1OfReal.hxx>
0024 #include <TColStd_HArray1OfInteger.hxx>
0025 #include <IGESGraph_HArray1OfColor.hxx>
0026 #include <IGESBasic_HArray1OfLineFontEntity.hxx>
0027 #include <IGESData_ViewKindEntity.hxx>
0028 #include <Standard_Integer.hxx>
0029 #include <Standard_Real.hxx>
0030 class IGESGraph_Color;
0031 class IGESData_LineFontEntity;
0032
0033 class IGESDraw_SegmentedViewsVisible;
0034 DEFINE_STANDARD_HANDLE(IGESDraw_SegmentedViewsVisible, IGESData_ViewKindEntity)
0035
0036 //! defines IGESSegmentedViewsVisible, Type <402> Form <19>
0037 //! in package IGESDraw
0038 //!
0039 //! Permits the association of display parameters with the
0040 //! segments of curves in a given view
0041 class IGESDraw_SegmentedViewsVisible : public IGESData_ViewKindEntity
0042 {
0043
0044 public:
0045   Standard_EXPORT IGESDraw_SegmentedViewsVisible();
0046
0047   //! This method is used to set the fields of the class
0048   //! SegmentedViewsVisible
0049   //! - allViews                : Pointers to View Entities
0050   //! - allBreakpointParameters : Parameters of breakpoints
0051   //! - allDisplayFlags         : Display flags
0052   //! - allColorValues          : Color Values
0053   //! - allColorDefinitions     : Color Definitions
0054   //! - allLineFontValues       : LineFont values
0055   //! - allLineFontDefinitions  : LineFont Definitions
0056   //! - allLineWeights          : Line weights
0057   //! raises exception if Lengths of allViews, allBreakpointParameters,
0058   //! allDisplayFlags, allColorValues, allColorDefinitions,
0059   //! allLineFontValues, allLineFontDefinitions and allLineWeights
0060   //! are not same.
0061   Standard_EXPORT void Init(const Handle(IGESDraw_HArray1OfViewKindEntity)& allViews,
0062                             const Handle(TColStd_HArray1OfReal)&            allBreakpointParameters,
0063                             const Handle(TColStd_HArray1OfInteger)&         allDisplayFlags,
0064                             const Handle(TColStd_HArray1OfInteger)&         allColorValues,
0065                             const Handle(IGESGraph_HArray1OfColor)&         allColorDefinitions,
0066                             const Handle(TColStd_HArray1OfInteger)&         allLineFontValues,
0067                             const Handle(IGESBasic_HArray1OfLineFontEntity)& allLineFontDefinitions,
0068                             const Handle(TColStd_HArray1OfInteger)&          allLineWeights);
0069
0070   //! Returns False (for a complex view)
0071   Standard_EXPORT Standard_Boolean IsSingle() const Standard_OVERRIDE;
0072
0073   //! Returns the count of Views referenced by <me> (inherited)
0074   Standard_EXPORT Standard_Integer NbViews() const Standard_OVERRIDE;
0075
0076   //! returns the number of view/segment blocks in <me>
0077   //! Similar to NbViews but has a more general significance
0078   Standard_EXPORT Standard_Integer NbSegmentBlocks() const;
0079
0080   //! returns the View entity indicated by ViewIndex
0081   //! raises an exception if ViewIndex <= 0 or
0082   //! ViewIndex > NbSegmentBlocks()
0083   Standard_EXPORT Handle(IGESData_ViewKindEntity) ViewItem(const Standard_Integer ViewIndex) const
0084     Standard_OVERRIDE;
0085
0086   //! returns the parameter of the breakpoint indicated by
0087   //! BreakpointIndex
0088   //! raises an exception if BreakpointIndex <= 0 or
0089   //! BreakpointIndex > NbSegmentBlocks().
0090   Standard_EXPORT Standard_Real BreakpointParameter(const Standard_Integer BreakpointIndex) const;
0091
0092   //! returns the Display flag indicated by FlagIndex
0093   //! raises an exception if FlagIndex <= 0 or
0094   //! FlagIndex > NbSegmentBlocks().
0095   Standard_EXPORT Standard_Integer DisplayFlag(const Standard_Integer FlagIndex) const;
0096
0097   //! returns True if the ColorIndex'th value of the
0098   //! "theColorDefinitions" field of <me> is a pointer
0099   //! raises an exception if ColorIndex <= 0 or
0100   //! ColorIndex > NbSegmentBlocks().
0101   Standard_EXPORT Standard_Boolean IsColorDefinition(const Standard_Integer ColorIndex) const;
0102
0103   //! returns the Color value indicated by ColorIndex
0104   //! raises an exception if ColorIndex <= 0 or
0105   //! ColorIndex > NbSegmentBlocks().
0106   Standard_EXPORT Standard_Integer ColorValue(const Standard_Integer ColorIndex) const;
0107
0108   //! returns the Color definition entity indicated by ColorIndex
0109   //! raises an exception if ColorIndex <= 0 or
0110   //! ColorIndex > NbSegmentBlocks().
0111   Standard_EXPORT Handle(IGESGraph_Color) ColorDefinition(const Standard_Integer ColorIndex) const;
0112
0113   //! returns True if the FontIndex'th value of the
0114   //! "theLineFontDefinitions" field of <me> is a pointer
0115   //! raises an exception if FontIndex <= 0 or
0116   //! FontIndex > NbSegmentBlocks().
0117   Standard_EXPORT Standard_Boolean IsFontDefinition(const Standard_Integer FontIndex) const;
0118
0119   //! returns the LineFont value indicated by FontIndex
0120   //! raises an exception if FontIndex <= 0 or
0121   //! FontIndex > NbSegmentBlocks().
0122   Standard_EXPORT Standard_Integer LineFontValue(const Standard_Integer FontIndex) const;
0123
0124   //! returns the LineFont definition entity indicated by FontIndex
0125   //! raises an exception if FontIndex <= 0 or
0126   //! FontIndex > NbSegmentBlocks().
0127   Standard_EXPORT Handle(IGESData_LineFontEntity) LineFontDefinition(
0128     const Standard_Integer FontIndex) const;
0129
0130   //! returns the LineWeight value indicated by WeightIndex
0131   //! raises an exception if WeightIndex <= 0 or
0132   //! WeightIndex > NbSegmentBlocks().
0133   Standard_EXPORT Standard_Integer LineWeightItem(const Standard_Integer WeightIndex) const;
0134
0135   DEFINE_STANDARD_RTTIEXT(IGESDraw_SegmentedViewsVisible, IGESData_ViewKindEntity)
0136
0137 protected:
0138 private:
0139   Handle(IGESDraw_HArray1OfViewKindEntity)  theViews;
0140   Handle(TColStd_HArray1OfReal)             theBreakpointParameters;
0141   Handle(TColStd_HArray1OfInteger)          theDisplayFlags;
0142   Handle(TColStd_HArray1OfInteger)          theColorValues;
0143   Handle(IGESGraph_HArray1OfColor)          theColorDefinitions;
0144   Handle(TColStd_HArray1OfInteger)          theLineFontValues;
0145   Handle(IGESBasic_HArray1OfLineFontEntity) theLineFontDefinitions;
0146   Handle(TColStd_HArray1OfInteger)          theLineWeights;
0147 };
0148
0149 #endif // _IGESDraw_SegmentedViewsVisible_HeaderFile