SoForeignFileKit.h
#ifndef COIN_SOFOREIGNFILEKIT_H
#define COIN_SOFOREIGNFILEKIT_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/SbBasic.h>
#include <Inventor/nodekits/SoSubKit.h>
#include <Inventor/nodekits/SoBaseKit.h>
typedef SbBool SoForeignFileIdentifyFunc(const char *);
class SoForeignFileKitP;
class COIN_DLL_API SoForeignFileKit : public SoBaseKit {
typedef SoBaseKit inherited;
SO_KIT_ABSTRACT_HEADER(SoForeignFileKit);
SO_KIT_CATALOG_ENTRY_HEADER(topSeparator);
public:
static void initClass(void);
static SbBool isFileSupported(SoInput * in, SbBool exhaust = FALSE);
static SbBool isFileSupported(const char * filename, SbBool exhaust = FALSE);
static SoForeignFileKit * createForeignFileKit(SoInput * in, SbBool exhaust = FALSE);
static SoForeignFileKit * createForeignFileKit(const char * filename, SbBool exhaust = FALSE);
// foreign read support
virtual SbBool canReadFile(const char * filename = NULL) const;
virtual SbBool readFile(const char * filename);
// foreign write support
virtual SbBool canWriteFile(const char * filename = NULL) const;
virtual SbBool writeFile(const char * filename);
virtual class SoSeparator *convert() = 0;
protected:
static void initClasses(void);
SoForeignFileKit(void);
virtual ~SoForeignFileKit(void);
static SbBool registerFileExtension(SoType handler, SbName extension, SoForeignFileIdentifyFunc * identify);
private:
SoForeignFileKitP * pimpl;
}; // SoForeignFileKit
#endif // !COIN_SOFOREIGNFILEKIT_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SoBaseKit::initClass
static void initClass(void)
Definition SoBaseKit.cpp:678
SoBaseKit::SoBaseKit
SoBaseKit(void)
Definition SoBaseKit.cpp:630
SoForeignFileKit::convert
virtual class SoSeparator * convert()=0
SoForeignFileKit::registerFileExtension
static SbBool registerFileExtension(SoType handler, SbName extension, SoForeignFileIdentifyFunc *identify)
Definition SoForeignFileKit.cpp:173
SoForeignFileKit::createForeignFileKit
static SoForeignFileKit * createForeignFileKit(SoInput *in, SbBool exhaust=FALSE)
Definition SoForeignFileKit.cpp:297
SoForeignFileKit::readFile
virtual SbBool readFile(const char *filename)
Definition SoForeignFileKit.cpp:334
SoForeignFileKit::writeFile
virtual SbBool writeFile(const char *filename)
Definition SoForeignFileKit.cpp:354
SoForeignFileKit::isFileSupported
static SbBool isFileSupported(SoInput *in, SbBool exhaust=FALSE)
Definition SoForeignFileKit.cpp:260
SoForeignFileKit::canWriteFile
virtual SbBool canWriteFile(const char *filename=NULL) const
Definition SoForeignFileKit.cpp:343
SoForeignFileKit::canReadFile
virtual SbBool canReadFile(const char *filename=NULL) const
Definition SoForeignFileKit.cpp:323
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