include/opencascade/Vrml_Texture2.hxx

0001 // Created on: 1997-02-11
0002 // Created by: Alexander BRIVIN
0003 // Copyright (c) 1997-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_Texture2_HeaderFile
0018 #define _Vrml_Texture2_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TCollection_AsciiString.hxx>
0025 #include <Vrml_Texture2Wrap.hxx>
0026 #include <Standard_OStream.hxx>
0027 class Vrml_SFImage;
0028
0029 //! defines a Texture2 node of VRML specifying properties of geometry
0030 //! and its appearance.
0031 //! This property node defines a texture map and parameters for that map
0032 //! The texture can be read from the URL specified by the filename field.
0033 //! To turn off texturing, set the filename field to an empty string ("").
0034 //! Textures can alsobe specified inline by setting the image field
0035 //! to contain the texture data.
0036 //! By default:
0037 //! myFilename ("")
0038 //! myImage (0 0 0)
0039 //! myWrapS (Vrml_REPEAT)
0040 //! myWrapT (Vrml_REPEAT)
0041 class Vrml_Texture2
0042 {
0043 public:
0044   DEFINE_STANDARD_ALLOC
0045
0046   Standard_EXPORT Vrml_Texture2();
0047
0048   Standard_EXPORT Vrml_Texture2(const TCollection_AsciiString&   aFilename,
0049                                 const occ::handle<Vrml_SFImage>& aImage,
0050                                 const Vrml_Texture2Wrap          aWrapS,
0051                                 const Vrml_Texture2Wrap          aWrapT);
0052
0053   Standard_EXPORT void SetFilename(const TCollection_AsciiString& aFilename);
0054
0055   Standard_EXPORT TCollection_AsciiString Filename() const;
0056
0057   Standard_EXPORT void SetImage(const occ::handle<Vrml_SFImage>& aImage);
0058
0059   Standard_EXPORT occ::handle<Vrml_SFImage> Image() const;
0060
0061   Standard_EXPORT void SetWrapS(const Vrml_Texture2Wrap aWrapS);
0062
0063   Standard_EXPORT Vrml_Texture2Wrap WrapS() const;
0064
0065   Standard_EXPORT void SetWrapT(const Vrml_Texture2Wrap aWrapT);
0066
0067   Standard_EXPORT Vrml_Texture2Wrap WrapT() const;
0068
0069   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0070
0071 private:
0072   TCollection_AsciiString   myFilename;
0073   occ::handle<Vrml_SFImage> myImage;
0074   Vrml_Texture2Wrap         myWrapS;
0075   Vrml_Texture2Wrap         myWrapT;
0076 };
0077
0078 #endif // _Vrml_Texture2_HeaderFile