Field containing multiple 2D images. More...

#include <Inventor/fields/SoMFImage.h>

Inheritance diagram for SoMFImage:

Public Types
enum	CopyPolicy { COPY = 0 , NO_COPY = 1 , NO_COPY_AND_DELETE = 2 , NO_COPY_AND_FREE = 3 }
	SoMFImage may be manipulating some large amounts of memory. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

const SoMFImage &	operator= (const SoMFImage &f)
	Copy from another field of same type.

	SoMFImage ()
	Default constructor.

virtual	~SoMFImage ()
	Destructor.

const unsigned char *	getValue (SbVec2s &size, int &nc) const
	Returns the pixels in the image as an array of unsigned chars.

void	setValue (const SbVec2s &size, int nc, const unsigned char *bytes, CopyPolicy copy=COPY)
	Sets the value of this field to be an image of the given size, with the given number of components, and with the given pixel values.

void	setNeverWrite (SbBool neverWrite)
	Sets the "neverWrite" flag.

SbBool	isNeverWrite ()
	Queries the "neverWrite" flag.

SbBool	hasTransparency () const
	Returns TRUE if the image contains any transparent pixels.

Public Member Functions inherited from SoMField
int	getNum () const
	Returns the number of values currently in the field.

void	setNum (int num)
	Forces this field to have exactly num values, inserting or deleting values as necessary.

virtual void	deleteValues (int start, int num=-1)
	Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created).

virtual void	insertSpace (int start, int num)
	Inserts space for num values at index start .

SoNONUNICODE SbBool	set1 (int index, const char *valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.

SbBool	set1 (int index, const SbString &valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.

void	get1 (int index, SbString &valueString)
	This is equivalent to the get() method of SoField, but operates on only one value.

Public Member Functions inherited from SoField
void	setIgnored (SbBool ig)
	Sets the ignore flag for this field.

SbBool	isIgnored () const
	Gets the ignore flag for this field.

SbBool	isDefault () const
	Gets the state of default flag of the field.

void	enableConnection (SbBool flag)
	Field connections may be enabled and disabled.

SbBool	isConnectionEnabled () const
	Returns FALSE if connections to this field are disabled.

SbBool	connectFrom (SoEngineOutput *engineOutput)
	Connects this field from an engine output.

SbBool	connectFrom (SoField *field)
	Connects this field to another field.

SbBool	connectFrom (SoVRMLInterpOutput *interpOutput)
	Connects this field from an interpOutput.

SbBool	appendConnection (SoEngineOutput *engineOutput)
	Appends this field to the list of connections from another engineOutput.

SbBool	appendConnection (SoField *field)
	Appends this field to the list of connections from another field.

SbBool	appendConnection (SoVRMLInterpOutput *interpOutput)
	Appends this field to the list of connections from another interpOutput.

void	disconnect (SoEngineOutput *engineOutput)
	Disconnect the field from the requested engineOutput.

void	disconnect (SoField *field)
	Disconnect the field from the requested field.

void	disconnect (SoVRMLInterpOutput *interpOutput)
	Disconnect the field from the requested interpOutput.

int	getNumConnections () const
	Returns the number of connections to this field.

int	getConnections (SoFieldList &list)
	Returns a list of the connections to this field.

void	disconnect ()
	Disconnect the field from whatever it was connected to.

SbBool	isConnected () const
	Returns TRUE if the field is connected to anything.

SbBool	isConnectedFromVRMLInterp () const
	Returns TRUE if the field is connected to a VRML interpOutput.

SbBool	isConnectedFromEngine () const
	Returns TRUE if the field is connected to an engine's output.

SbBool	isConnectedFromField () const
	Returns TRUE if the field is connected to another field.

SbBool	getConnectedEngine (SoEngineOutput *&engineOutput) const
	Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.

SbBool	getConnectedField (SoField *&writingField) const
	Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.

SbBool	getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
	Returns the VRMLInterpolator output field is connected to.

int	getForwardConnections (SoFieldList &list) const
	Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.

SoFieldContainer *	getContainer () const
	Returns the object that contains this field.

SoNONUNICODE SbBool	set (const char *valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

SbBool	set (const SbString &valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

void	get (SbString &valueString)
	Returns the value of the field in the Open Inventor file format, even if the field has its default value.

virtual size_t	getValueSize () const
	Gets the size of the value.

virtual void	touch ()
	Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.

int	operator== (const SoField &f) const
	Return TRUE if this field is of the same type and has the same value as f.

int	operator!= (const SoField &f) const
	Return FALSE if this field is of the same type and has the same value as f.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoMField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Field containing multiple 2D images.

A field containing two-dimensional images. Images can be grayscale (intensity), grayscale with transparency information, RGB, or RGB with transparency. Each component of the image (intensity, red, green, blue or transparency (alpha)) can have an unsigned one-byte value from 0 to 255.

Values are returned as arrays of unsigned chars. The image is stored in this array starting at the bottom left corner of the image with the intensity or red component of that pixel, followed by either the alpha, the green and blue, or the green, blue and alpha components (depending on the number of components in the image). The next value is the first component of the next pixel to the right.

SoMFImages are written to file as three integers representing the width, height and number of components in the image, followed by width*height hexadecimal values representing the pixels in the image, separated by whitespace. A one-component image will have one-byte hexadecimal values representing the intensity of the image. For example, 0xFF is full intensity, 0x00 is no intensity. A two-component image puts the intensity in the first (high) byte and the transparency in the second (low) byte. Pixels in a three-component image have the red component in the first (high) byte, followed by the green and blue components (so 0xFF0000 is red). Four-component images put the transparency byte after red/green/blue (so 0x0000FF80 is semi-transparent blue). Note: each pixel is actually read as a single unsigned number, so a 3-component pixel with value "0x0000FF" can also be written as "0xFF" or "255" (decimal).

For example,

   1 2 1 0xFF 0x00

is a 1 pixel wide by 2 pixel high grayscale image, with the bottom pixel white and the top pixel black. And:

   2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00

is a 2 pixel wide by 4 pixel high RGB image, with the bottom left pixel red, the bottom right pixel green, the two middle rows of pixels black, the top left pixel white, and the top right pixel yellow.

Data copying:

: SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

Member Enumeration Documentation

◆ CopyPolicy

enum SoMFImage::CopyPolicy

SoMFImage may be manipulating some large amounts of memory.

It is therefore convienent to be able to set the memory usage policy dynamically. By default, the memory policy is COPY, which is consistent with other OIV fields. The most likely to be efficient is NO_COPY. See also setNeverWrite.

Enumerator
COPY	Open Inventor will make a copy of the data (default)
NO_COPY	Passed buffer used, user will delete.
NO_COPY_AND_DELETE	Passed buffer used, SoMFImage will delete. Use this if memory is allocated with "new".
NO_COPY_AND_FREE	Passed buffer used, SoMFImage will free. Use this if memory is allocated with "malloc".

Definition at line 116 of file SoMFImage.h.

Constructor & Destructor Documentation

◆ SoMFImage()

SoMFImage::SoMFImage ( )

Default constructor.

◆ ~SoMFImage()

virtual SoMFImage::~SoMFImage ( )

virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoMFImage::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoMFImage::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValue()

const unsigned char * SoMFImage::getValue	(	SbVec2s &	size,
		int &	nc
	)		const

Returns the pixels in the image as an array of unsigned chars.

The size and nc arguments are filled in with the dimensions of the image and the number of components in the image; the number of bytes in the array returned will be size[0]* size[1]* nc.

◆ hasTransparency()

SbBool SoMFImage::hasTransparency ( ) const

Returns TRUE if the image contains any transparent pixels.

Specifically if the image has 2 or 4 components and at least one pixel has an alpha value less then 255.

◆ isNeverWrite()

SbBool SoMFImage::isNeverWrite ( )

inline

Queries the "neverWrite" flag.

Definition at line 252 of file SoMFImage.h.

◆ operator=()

const SoMFImage & SoMFImage::operator= ( const SoMFImage & f )

Copy from another field of same type.

◆ setNeverWrite()

void SoMFImage::setNeverWrite ( SbBool neverWrite )

Sets the "neverWrite" flag.

As this field may have to handle large amounts of data and its representation in an .iv file is not very efficient, it is often a good idea not to allow that data to be written out when required by a write action. By default, the "neverWrite" condition is FALSE.

◆ setValue()

void SoMFImage::setValue	(	const SbVec2s &	size,
		int	nc,
		const unsigned char *	bytes,
		CopyPolicy	copy = `COPY`
	)

Sets the value of this field to be an image of the given size, with the given number of components, and with the given pixel values.

size[0]* size[1]* nc bytes from the given array will be copied into internal storage maintained by the SoMFImage field.

At times, SoMFImage may need to manipulate large amounts of memory. Therefore, it is useful to be able to specify the memory usage policy dynamically. By default, the memory policy is COPY, which is consistent with other Open Inventor fields. The most likely to be efficient is NO_COPY. See also setNeverWrite().

The documentation for this class was generated from the following file:

Inventor/fields/SoMFImage.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions