Coin: SoForeignFileKit.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoForeignFileKit.h
1#ifndef COIN_SOFOREIGNFILEKIT_H
2#define COIN_SOFOREIGNFILEKIT_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbBasic.h>
37
38#include <Inventor/nodekits/SoSubKit.h>
39#include <Inventor/nodekits/SoBaseKit.h>
40
41typedef SbBool SoForeignFileIdentifyFunc(const char *);
42
43class SoForeignFileKitP;
44
45 class COIN_DLL_API SoForeignFileKit : public SoBaseKit {
46 typedef SoBaseKit inherited;
47
48 SO_KIT_ABSTRACT_HEADER(SoForeignFileKit);
49 SO_KIT_CATALOG_ENTRY_HEADER(topSeparator);
50
51public:
52 static void initClass(void);
53
54 static SbBool isFileSupported(SoInput * in, SbBool exhaust = FALSE);
55 static SbBool isFileSupported(const char * filename, SbBool exhaust = FALSE);
56
57 static SoForeignFileKit * createForeignFileKit(SoInput * in, SbBool exhaust = FALSE);
58 static SoForeignFileKit * createForeignFileKit(const char * filename, SbBool exhaust = FALSE);
59
60 // foreign read support
61 virtual SbBool canReadFile(const char * filename = NULL) const;
62 virtual SbBool readFile(const char * filename);
63 // foreign write support
64 virtual SbBool canWriteFile(const char * filename = NULL) const;
65 virtual SbBool writeFile(const char * filename);
66
71 virtual class SoSeparator *convert() = 0;
72
73protected:
74 static void initClasses(void);
75
76 SoForeignFileKit(void);
77 virtual ~SoForeignFileKit(void);
78
79 static SbBool registerFileExtension(SoType handler, SbName extension, SoForeignFileIdentifyFunc * identify);
80
81private:
82 SoForeignFileKitP * pimpl;
83
84}; // SoForeignFileKit
85
86#endif // !COIN_SOFOREIGNFILEKIT_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SoBaseKit
The SoBaseKit class is the top level superclass for nodekits.
Definition SoBaseKit.h:66
SoBaseKit::initClass
static void initClass(void)
Definition SoBaseKit.cpp:678
SoForeignFileKit
Abstract base class for foreign file format support in Coin.
Definition SoForeignFileKit.h:45
SoForeignFileKit::convert
virtual class SoSeparator * convert()=0
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNode::initClasses
static void initClasses(void)
Definition SoNode.cpp:604
SoSeparator
The SoSeparator class is a state-preserving group node.
Definition SoSeparator.h:44
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59