1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-06 10:36:12 +03:00
occt/src/IGESDraw/IGESDraw_SegmentedViewsVisible.hxx
abv 42cf5bc1ca 0024002: Overall code and build procedure refactoring -- automatic
Automatic upgrade of OCCT code by command "occt_upgrade . -nocdl":
- WOK-generated header files from inc and sources from drv are moved to src
- CDL files removed
- All packages are converted to nocdlpack
2015-07-12 07:42:38 +03:00

166 lines
6.5 KiB
C++

// Created on: 1993-01-09
// Created by: CKY / Contract Toubro-Larsen ( TCD )
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _IGESDraw_SegmentedViewsVisible_HeaderFile
#define _IGESDraw_SegmentedViewsVisible_HeaderFile
#include <Standard.hxx>
#include <Standard_Type.hxx>
#include <IGESDraw_HArray1OfViewKindEntity.hxx>
#include <TColStd_HArray1OfReal.hxx>
#include <TColStd_HArray1OfInteger.hxx>
#include <IGESGraph_HArray1OfColor.hxx>
#include <IGESBasic_HArray1OfLineFontEntity.hxx>
#include <IGESData_ViewKindEntity.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Integer.hxx>
#include <Standard_Real.hxx>
class Standard_DimensionMismatch;
class Standard_OutOfRange;
class IGESData_ViewKindEntity;
class IGESGraph_Color;
class IGESData_LineFontEntity;
class IGESDraw_SegmentedViewsVisible;
DEFINE_STANDARD_HANDLE(IGESDraw_SegmentedViewsVisible, IGESData_ViewKindEntity)
//! defines IGESSegmentedViewsVisible, Type <402> Form <19>
//! in package IGESDraw
//!
//! Permits the association of display parameters with the
//! segments of curves in a given view
class IGESDraw_SegmentedViewsVisible : public IGESData_ViewKindEntity
{
public:
Standard_EXPORT IGESDraw_SegmentedViewsVisible();
//! This method is used to set the fields of the class
//! SegmentedViewsVisible
//! - allViews : Pointers to View Entities
//! - allBreakpointParameters : Parameters of breakpoints
//! - allDisplayFlags : Display flags
//! - allColorValues : Color Values
//! - allColorDefinitions : Color Definitions
//! - allLineFontValues : LineFont values
//! - allLineFontDefinitions : LineFont Definitions
//! - allLineWeights : Line weights
//! raises exception if Lengths of allViews, allBreakpointParameters,
//! allDisplayFlags, allColorValues, allColorDefinitions,
//! allLineFontValues, allLineFontDefinitions and allLineWeights
//! are not same.
Standard_EXPORT void Init (const Handle(IGESDraw_HArray1OfViewKindEntity)& allViews, const Handle(TColStd_HArray1OfReal)& allBreakpointParameters, const Handle(TColStd_HArray1OfInteger)& allDisplayFlags, const Handle(TColStd_HArray1OfInteger)& allColorValues, const Handle(IGESGraph_HArray1OfColor)& allColorDefinitions, const Handle(TColStd_HArray1OfInteger)& allLineFontValues, const Handle(IGESBasic_HArray1OfLineFontEntity)& allLineFontDefinitions, const Handle(TColStd_HArray1OfInteger)& allLineWeights);
//! Returns False (for a complex view)
Standard_EXPORT Standard_Boolean IsSingle() const;
//! Returns the count of Views referenced by <me> (inherited)
Standard_EXPORT Standard_Integer NbViews() const;
//! returns the number of view/segment blocks in <me>
//! Similar to NbViews but has a more general significance
Standard_EXPORT Standard_Integer NbSegmentBlocks() const;
//! returns the View entity indicated by ViewIndex
//! raises an exception if ViewIndex <= 0 or
//! ViewIndex > NbSegmentBlocks()
Standard_EXPORT Handle(IGESData_ViewKindEntity) ViewItem (const Standard_Integer ViewIndex) const;
//! returns the parameter of the breakpoint indicated by
//! BreakpointIndex
//! raises an exception if BreakpointIndex <= 0 or
//! BreakpointIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Real BreakpointParameter (const Standard_Integer BreakpointIndex) const;
//! returns the Display flag indicated by FlagIndex
//! raises an exception if FlagIndex <= 0 or
//! FlagIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Integer DisplayFlag (const Standard_Integer FlagIndex) const;
//! returns True if the ColorIndex'th value of the
//! "theColorDefinitions" field of <me> is a pointer
//! raises an exception if ColorIndex <= 0 or
//! ColorIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Boolean IsColorDefinition (const Standard_Integer ColorIndex) const;
//! returns the Color value indicated by ColorIndex
//! raises an exception if ColorIndex <= 0 or
//! ColorIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Integer ColorValue (const Standard_Integer ColorIndex) const;
//! returns the Color definition entity indicated by ColorIndex
//! raises an exception if ColorIndex <= 0 or
//! ColorIndex > NbSegmentBlocks().
Standard_EXPORT Handle(IGESGraph_Color) ColorDefinition (const Standard_Integer ColorIndex) const;
//! returns True if the FontIndex'th value of the
//! "theLineFontDefinitions" field of <me> is a pointer
//! raises an exception if FontIndex <= 0 or
//! FontIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Boolean IsFontDefinition (const Standard_Integer FontIndex) const;
//! returns the LineFont value indicated by FontIndex
//! raises an exception if FontIndex <= 0 or
//! FontIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Integer LineFontValue (const Standard_Integer FontIndex) const;
//! returns the LineFont definition entity indicated by FontIndex
//! raises an exception if FontIndex <= 0 or
//! FontIndex > NbSegmentBlocks().
Standard_EXPORT Handle(IGESData_LineFontEntity) LineFontDefinition (const Standard_Integer FontIndex) const;
//! returns the LineWeight value indicated by WeightIndex
//! raises an exception if WeightIndex <= 0 or
//! WeightIndex > NbSegmentBlocks().
Standard_EXPORT Standard_Integer LineWeightItem (const Standard_Integer WeightIndex) const;
DEFINE_STANDARD_RTTI(IGESDraw_SegmentedViewsVisible,IGESData_ViewKindEntity)
protected:
private:
Handle(IGESDraw_HArray1OfViewKindEntity) theViews;
Handle(TColStd_HArray1OfReal) theBreakpointParameters;
Handle(TColStd_HArray1OfInteger) theDisplayFlags;
Handle(TColStd_HArray1OfInteger) theColorValues;
Handle(IGESGraph_HArray1OfColor) theColorDefinitions;
Handle(TColStd_HArray1OfInteger) theLineFontValues;
Handle(IGESBasic_HArray1OfLineFontEntity) theLineFontDefinitions;
Handle(TColStd_HArray1OfInteger) theLineWeights;
};
#endif // _IGESDraw_SegmentedViewsVisible_HeaderFile