include/opencascade/Vrml_SFImage.hxx

0001 // Created on: 1996-12-23
0002 // Created by: Alexander BRIVIN
0003 // Copyright (c) 1996-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 _Vrml_SFImage_HeaderFile
0018 #define _Vrml_SFImage_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <Vrml_SFImageNumber.hxx>
0025 #include <NCollection_Array1.hxx>
0026 #include <NCollection_HArray1.hxx>
0027 #include <Standard_Transient.hxx>
0028
0029 //! defines SFImage type of VRML field types.
0030 class Vrml_SFImage : public Standard_Transient
0031 {
0032
0033 public:
0034   Standard_EXPORT Vrml_SFImage();
0035
0036   Standard_EXPORT Vrml_SFImage(const int                                    aWidth,
0037                                const int                                    aHeight,
0038                                const Vrml_SFImageNumber                     aNumber,
0039                                const occ::handle<NCollection_HArray1<int>>& anArray);
0040
0041   Standard_EXPORT void SetWidth(const int aWidth);
0042
0043   Standard_EXPORT int Width() const;
0044
0045   Standard_EXPORT void SetHeight(const int aHeight);
0046
0047   Standard_EXPORT int Height() const;
0048
0049   Standard_EXPORT void SetNumber(const Vrml_SFImageNumber aNumber);
0050
0051   Standard_EXPORT Vrml_SFImageNumber Number() const;
0052
0053   Standard_EXPORT void SetArray(const occ::handle<NCollection_HArray1<int>>& anArray);
0054
0055   Standard_EXPORT occ::handle<NCollection_HArray1<int>> Array() const;
0056
0057   Standard_EXPORT bool ArrayFlag() const;
0058
0059   DEFINE_STANDARD_RTTIEXT(Vrml_SFImage, Standard_Transient)
0060
0061 private:
0062   int                                   myWidth;
0063   int                                   myHeight;
0064   Vrml_SFImageNumber                    myNumber;
0065   occ::handle<NCollection_HArray1<int>> myArray;
0066   bool                                  myArrayFlag;
0067 };
0068
0069 #endif // _Vrml_SFImage_HeaderFile