Package com.openinventor.inventor.image
Class SoRasterImageFile
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.inventor.image.SoRasterImageIO
-
- com.openinventor.inventor.image.SoRasterImageFile
-
public class SoRasterImageFile extends SoRasterImageIO
Class for raster image file input and output. Class for raster image file input and output.- See Also:
SoRasterImageIO
,SoRasterImageRW
,SbRasterImage
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand
-
-
Field Summary
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor Description SoRasterImageFile()
Constructor.SoRasterImageFile(java.lang.String fileName)
Constructor that takes a file name.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
closeFile()
Close the file.java.lang.String
getFileName()
Returns the file name that was given in the filename constructor.java.lang.String
getFileSuffix()
Returns the file suffix.java.lang.String
getFullPathFileName()
Returns the file name as a full path.java.lang.String
getStringFileName()
Returns the file name that was given in the filename constructor.java.lang.String
getStringFullPathFileName()
Returns the file name as a full path.boolean
isBinary()
Returns the file open binary mode.void
nullFilePtr()
Sets the filePointer to NULL for files closed internally such as RGB files.boolean
openFile(SoRasterImageRW.OpenModes openMode)
Deprecated.As of Open Inventor 9000.boolean
openWrite()
Open the file (specified withsetFileName
) for writing.void
setBinary(boolean isBinary)
Sets the file open binary mode.void
setFileName(java.lang.String fileName)
Sets the file name.-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Method Detail
-
openFile
@Deprecated public boolean openFile(SoRasterImageRW.OpenModes openMode)
Deprecated.As of Open Inventor 9000. Use openRead() or openWrite() instead.Opens the file with the specified open mode.Warning Deprecated since Open Inventor 9000. Use openRead() or
openWrite()
instead.
-
openWrite
public boolean openWrite()
Open the file (specified withsetFileName
) for writing. The filename should be a full path. Returns true if successful.
-
isBinary
public boolean isBinary()
Returns the file open binary mode.
-
getFileName
public java.lang.String getFileName()
Returns the file name that was given in the filename constructor. If the filename constructor was not used, this method returns an empty string. To get the file name as a full path, the methodsgetFullPathFileName()
orgetStringFullPathFileName()
should be used.
-
nullFilePtr
public void nullFilePtr()
Sets the filePointer to NULL for files closed internally such as RGB files.
-
getStringFullPathFileName
public java.lang.String getStringFullPathFileName()
Returns the file name as a full path. If the filename constructor was not used, this method returns an empty string. This method should be called after openRead() oropenWrite()
, or else it will return an empty string. To get the file name as it was passed to the constructor, the methodsgetFileName()
orgetStringFileName()
should be used.
-
closeFile
public void closeFile()
Close the file.
-
setFileName
public void setFileName(java.lang.String fileName)
Sets the file name.
-
setBinary
public void setBinary(boolean isBinary)
Sets the file open binary mode.
-
getStringFileName
public java.lang.String getStringFileName()
Returns the file name that was given in the filename constructor. If the filename constructor was not used, this method returns an empty string. To get the file name as a full path, the methodsgetFullPathFileName()
orgetStringFullPathFileName()
should be used.
-
getFileSuffix
public java.lang.String getFileSuffix()
Returns the file suffix.
-
getFullPathFileName
public java.lang.String getFullPathFileName()
Returns the file name as a full path. If the filename constructor was not used, this method returns an empty string.This method should be called after openRead() or
openWrite()
, or else it will return an empty string. To get the file name as it was passed to the constructor, the methodsgetFileName()
orgetStringFileName()
should be used.
-
-