An image-based field giving the pixel colour/intensity values. More...

#include <fieldimage.hpp>

Inheritance diagram for OpenCMISS::Zinc::FieldImage:

Public Types
enum	CombineMode { COMBINE_MODE_INVALID = CMZN_FIELD_IMAGE_COMBINE_MODE_INVALID, COMBINE_MODE_BLEND = CMZN_FIELD_IMAGE_COMBINE_MODE_BLEND, COMBINE_MODE_DECAL = CMZN_FIELD_IMAGE_COMBINE_MODE_DECAL, COMBINE_MODE_MODULATE = CMZN_FIELD_IMAGE_COMBINE_MODE_MODULATE, COMBINE_MODE_ADD = CMZN_FIELD_IMAGE_COMBINE_MODE_ADD, COMBINE_MODE_ADD_SIGNED = CMZN_FIELD_IMAGE_COMBINE_MODE_ADD_SIGNED, COMBINE_MODE_MODULATE_SCALE_4 = CMZN_FIELD_IMAGE_COMBINE_MODE_MODULATE_SCALE_4, COMBINE_MODE_BLEND_SCALE_4 = CMZN_FIELD_IMAGE_COMBINE_MODE_BLEND_SCALE_4, COMBINE_MODE_SUBTRACT = CMZN_FIELD_IMAGE_COMBINE_MODE_SUBTRACT, COMBINE_MODE_ADD_SCALE_4 = CMZN_FIELD_IMAGE_COMBINE_MODE_ADD_SCALE_4, COMBINE_MODE_SUBTRACT_SCALE_4 = CMZN_FIELD_IMAGE_COMBINE_MODE_SUBTRACT_SCALE_4, COMBINE_MODE_INVERT_ADD_SCALE_4 = CMZN_FIELD_IMAGE_COMBINE_MODE_INVERT_ADD_SCALE_4, COMBINE_MODE_INVERT_SUBTRACT_SCALE_4 = CMZN_FIELD_IMAGE_COMBINE_MODE_INVERT_SUBTRACT_SCALE_4 }

enum	FilterMode { FILTER_MODE_INVALID = CMZN_FIELD_IMAGE_FILTER_MODE_INVALID, FILTER_MODE_NEAREST = CMZN_FIELD_IMAGE_FILTER_MODE_NEAREST, FILTER_MODE_LINEAR = CMZN_FIELD_IMAGE_FILTER_MODE_LINEAR, FILTER_MODE_NEAREST_MIPMAP_NEAREST = CMZN_FIELD_IMAGE_FILTER_MODE_NEAREST_MIPMAP_NEAREST, FILTER_MODE_LINEAR_MIPMAP_NEAREST = CMZN_FIELD_IMAGE_FILTER_MODE_LINEAR_MIPMAP_NEAREST, FILTER_MODE_LINEAR_MIPMAP_LINEAR = CMZN_FIELD_IMAGE_FILTER_MODE_LINEAR_MIPMAP_LINEAR }

enum	HardwareCompressionMode { HARDWARE_COMPRESSION_MODE_INVALID = CMZN_FIELD_IMAGE_HARDWARE_COMPRESSION_MODE_INVALID, HARDWARE_COMPRESSION_MODE_UNCOMPRESSED = CMZN_FIELD_IMAGE_HARDWARE_COMPRESSION_MODE_UNCOMPRESSED, HARDWARE_COMPRESSION_MODE_AUTOMATIC = CMZN_FIELD_IMAGE_HARDWARE_COMPRESSION_MODE_AUTOMATIC }

enum	WrapMode { WRAP_MODE_INVALID = CMZN_FIELD_IMAGE_WRAP_MODE_INVALID, WRAP_MODE_CLAMP = CMZN_FIELD_IMAGE_WRAP_MODE_CLAMP, WRAP_MODE_REPEAT = CMZN_FIELD_IMAGE_WRAP_MODE_REPEAT, WRAP_MODE_EDGE_CLAMP = CMZN_FIELD_IMAGE_WRAP_MODE_EDGE_CLAMP, WRAP_MODE_BORDER_CLAMP = CMZN_FIELD_IMAGE_WRAP_MODE_BORDER_CLAMP, WRAP_MODE_MIRROR_REPEAT = CMZN_FIELD_IMAGE_WRAP_MODE_MIRROR_REPEAT }

Public Types inherited from OpenCMISS::Zinc::Field
enum	ChangeFlag { CHANGE_FLAG_NONE = CMZN_FIELD_CHANGE_FLAG_NONE, CHANGE_FLAG_ADD = CMZN_FIELD_CHANGE_FLAG_ADD, CHANGE_FLAG_REMOVE = CMZN_FIELD_CHANGE_FLAG_REMOVE, CHANGE_FLAG_IDENTIFIER = CMZN_FIELD_CHANGE_FLAG_IDENTIFIER, CHANGE_FLAG_DEFINITION = CMZN_FIELD_CHANGE_FLAG_DEFINITION, CHANGE_FLAG_FULL_RESULT = CMZN_FIELD_CHANGE_FLAG_FULL_RESULT, CHANGE_FLAG_PARTIAL_RESULT = CMZN_FIELD_CHANGE_FLAG_PARTIAL_RESULT, CHANGE_FLAG_RESULT = CMZN_FIELD_CHANGE_FLAG_RESULT, CHANGE_FLAG_FINAL = CMZN_FIELD_CHANGE_FLAG_FINAL }

enum	CoordinateSystemType { COORDINATE_SYSTEM_TYPE_INVALID = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_INVALID, COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN, COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR, COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR, COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_FIBRE = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_FIBRE }

enum	DomainType { DOMAIN_TYPE_INVALID = CMZN_FIELD_DOMAIN_TYPE_INVALID, DOMAIN_TYPE_POINT = CMZN_FIELD_DOMAIN_TYPE_POINT, DOMAIN_TYPE_NODES = CMZN_FIELD_DOMAIN_TYPE_NODES, DOMAIN_TYPE_DATAPOINTS = CMZN_FIELD_DOMAIN_TYPE_DATAPOINTS, DOMAIN_TYPE_MESH1D = CMZN_FIELD_DOMAIN_TYPE_MESH1D, DOMAIN_TYPE_MESH2D = CMZN_FIELD_DOMAIN_TYPE_MESH2D, DOMAIN_TYPE_MESH3D = CMZN_FIELD_DOMAIN_TYPE_MESH3D, DOMAIN_TYPE_MESH_HIGHEST_DIMENSION = CMZN_FIELD_DOMAIN_TYPE_MESH_HIGHEST_DIMENSION }

enum	ValueType { VALUE_TYPE_INVALID = CMZN_FIELD_VALUE_TYPE_INVALID, VALUE_TYPE_REAL = CMZN_FIELD_VALUE_TYPE_REAL, VALUE_TYPE_STRING = CMZN_FIELD_VALUE_TYPE_STRING, VALUE_TYPE_MESH_LOCATION = CMZN_FIELD_VALUE_TYPE_MESH_LOCATION }

typedef int	ChangeFlags

typedef int	DomainTypes

Public Member Functions
	FieldImage (cmzn_field_image_id field_image_id)

int	getWidthInPixels ()

int	getHeightInPixels ()

int	getDepthInPixels ()

int	getSizeInPixels (int valuesCount, int *valuesOut)

int	setSizeInPixels (int valuesCount, const int *valuesIn)

double	getTextureCoordinateWidth ()

double	getTextureCoordinateHeight ()

double	getTextureCoordinateDepth ()

int	getTextureCoordinateSizes (int valuesCount, double *valuesOut)

int	setTextureCoordinateWidth (double width)

int	setTextureCoordinateHeight (double height)

int	setTextureCoordinateDepth (double depth)

int	setTextureCoordinateSizes (int valuesCount, const double *valuesIn)

int	read (const StreaminformationImage &streaminformationImage)

int	readFile (const char *fileName)

int	write (const StreaminformationImage &streaminformationImage)

CombineMode	getCombineMode ()

int	setCombineMode (CombineMode combineMode)

Field	getDomainField ()

int	setDomainField (const Field &domainField)

HardwareCompressionMode	getHardwareCompressionMode ()

int	setHardwareCompressionMode (HardwareCompressionMode hardwareCompressionMode)

FilterMode	getFilterMode ()

int	setFilterMode (FilterMode filterMode)

WrapMode	getWrapMode ()

int	setWrapMode (WrapMode wrapMode)

char *	getProperty (const char *property)

StreaminformationImage	createStreaminformationImage ()

Public Member Functions inherited from OpenCMISS::Zinc::Field
	Field (cmzn_field_id field_id)

	Field (const Field &field)

Field &	operator= (const Field &field)

bool	isValid () const

cmzn_field_id	getId () const

Fieldassignment	createFieldassignment (const Field &sourceField)

bool	isManaged ()

int	setManaged (bool value)

char *	getComponentName (int componentNumber)

int	setComponentName (int componentNumber, const char *name)

double	getCoordinateSystemFocus ()

int	setCoordinateSystemFocus (double focus)

CoordinateSystemType	getCoordinateSystemType ()

int	setCoordinateSystemType (CoordinateSystemType coordinateSystemType)

int	getNumberOfComponents ()

char *	getName ()

int	setName (const char *name)

int	getNumberOfSourceFields ()

Field	getSourceField (int index)

bool	isTypeCoordinate ()

int	setTypeCoordinate (bool value)

ValueType	getValueType ()

Fieldmodule	getFieldmodule () const

int	assignMeshLocation (const Fieldcache &cache, const Element &element, int coordinatesCount, const double *coordinatesIn)

int	assignReal (const Fieldcache &cache, int valuesCount, const double *valuesIn)

int	assignString (const Fieldcache &cache, const char *stringValue)

Element	evaluateMeshLocation (const Fieldcache &cache, int coordinatesCount, double *coordinatesOut)

int	evaluateReal (const Fieldcache &cache, int valuesCount, double *valuesOut)

char *	evaluateString (const Fieldcache &cache)

int	evaluateDerivative (const Differentialoperator&differentialOperator, const Fieldcache &cache, int valuesCount, double *valuesOut)

bool	isDefinedAtLocation (const Fieldcache &cache)

int	smooth (const Fieldsmoothing &fieldsmoothing)

FieldComponent	castComponent ()

FieldEdgeDiscontinuity	castEdgeDiscontinuity ()

FieldEigenvalues	castEigenvalues ()

FieldElementGroup	castElementGroup ()

FieldFindMeshLocation	castFindMeshLocation ()

FieldFiniteElement	castFiniteElement ()

FieldGroup	castGroup ()

FieldImage	castImage ()

FieldImagefilterBinaryThreshold	castImagefilterBinaryThreshold ()

FieldImagefilterDiscreteGaussian	castImagefilterDiscreteGaussian ()

FieldImagefilterHistogram	castImagefilterHistogram ()

FieldImagefilterThreshold	castImagefilterThreshold ()

FieldMeshIntegral	castMeshIntegral ()

FieldNodeGroup	castNodeGroup ()

FieldStoredMeshLocation	castStoredMeshLocation ()

FieldStoredString	castStoredString ()

Additional Inherited Members
Protected Attributes inherited from OpenCMISS::Zinc::Field
cmzn_field_id	id

Detailed Description

An image-based field giving the pixel colour/intensity values.

An image-based field giving the pixel colour/intensity values as a function of its domain texture coordinates, interpolated between pixels according to the filter mode. 2-D and 3-D images are supported. Graphics materials can have image fields attached to perform texturing.

Member Enumeration Documentation

enum OpenCMISS::Zinc::FieldImage::CombineMode

Describes the blending of the texture with the texture constant colour and the underlying material/fragment colour.

Ct = texture colour, Cf = material colour, Cv = colour produced At = texture alpha, Af = material alpha, alpha = colour produced

Enumerator
COMBINE_MODE_INVALID	Unspecified combine mode
COMBINE_MODE_BLEND	Blending the material and texture colour Cv = (1 - Ct) * Cf Av = At * Af
COMBINE_MODE_DECAL	Default combine mode, uses the image's alpha value to determine how the material colour is to combine with the texture colour. Material alpha value will be used as the resulting alpha. Cv = (1 - At) Ct + At C Av = Af
COMBINE_MODE_MODULATE	Colour will be the product of texture and material colour. Alpha will be the product of texture and material alph. Cv = Ct * Cf Av = At * Af
COMBINE_MODE_ADD	Colour will be the sum of texture and material colour. Alpha will be the sum of texture and material alph. Cv = Ct + Cf Av = At + Af
COMBINE_MODE_ADD_SIGNED	Add the value and subtract 0.5 so the texture value effectively ranges from -0.5 to 0.5 Cv = Ct + Cf - 0.5 Av = At + Af - 0.5
COMBINE_MODE_MODULATE_SCALE_4	Multiply and then scale by 4, so that we can scale down or up. Cv = (Ct * Cf) * 4 Av = At * Af
COMBINE_MODE_BLEND_SCALE_4	Same as blend with a 4 * scaling Cv = ( (1 - Ct) * Cf ) * 4 Av = At * Af
COMBINE_MODE_SUBTRACT	Colour will be the difference of texture and material colour. Alpha will be the difference of texture and material alph. Cv = Ct - Cf Av = At - Af
COMBINE_MODE_ADD_SCALE_4	Same as ADD with a 4 * scaling Cv = (Ct + Cf) * 4 Av = At + Af
COMBINE_MODE_SUBTRACT_SCALE_4	Same as SUBTRACT with a 4 * scaling Cv = (Ct - Cf) * 4 Av = At - Af
COMBINE_MODE_INVERT_ADD_SCALE_4	Texture colour will be added to 1 - material colour and then multiplied by 4. Cv = ((1 - Cf) + Ct) * 4 Av = Af + At
COMBINE_MODE_INVERT_SUBTRACT_SCALE_4	Texture colour will be subtracted frim 1 - material colour then multiplied by 4. Cv = ((1 - Cf) - Ct) * 4 Av = Af - At

enum OpenCMISS::Zinc::FieldImage::FilterMode

Specifies how the graphics hardware rasterises the texture onto the screen, mainly its interpolation mode.

Enumerator
FILTER_MODE_INVALID	Unspecified filter mode
FILTER_MODE_NEAREST	Default combine mode, texel with coordinates nearest the centre of the pixel is used for both magnification and minification
FILTER_MODE_LINEAR	A weighted linear average of the 2 x 2 arrays of texels that lie nearest to the centre of the pixel is used for both magnification and minification
FILTER_MODE_NEAREST_MIPMAP_NEAREST	Within an individual mipmap, nearest texel value can be used using this mode.
FILTER_MODE_LINEAR_MIPMAP_NEAREST	Within an individual mipmap, linearly interpolated value can be used using this mode.
FILTER_MODE_LINEAR_MIPMAP_LINEAR	This mode uses linear interpolation to compute the value in each of two maps and then interpolates linearly between these two values.

enum OpenCMISS::Zinc::FieldImage::HardwareCompressionMode

Whether the image is compressed when used for texturing.

Could add hardware/driver specific compression formats.

Enumerator
HARDWARE_COMPRESSION_MODE_INVALID	Uncompressed compression mode
HARDWARE_COMPRESSION_MODE_UNCOMPRESSED	No compression. The default hardware compression mode
HARDWARE_COMPRESSION_MODE_AUTOMATIC	allow the hardware to choose the compression

enum OpenCMISS::Zinc::FieldImage::WrapMode

Describes how the image is to be wrapped when texture coordinate is assigned outside the range [0,1], you can choose to have them clamp or repeat.

Enumerator
WRAP_MODE_INVALID	Unspecified wrap mode
WRAP_MODE_CLAMP	Clamp to a blend of the pixel edge and border colour
WRAP_MODE_REPEAT	Default wrap mode. Repeat texture cylically in multiples of the texture coordinate range
WRAP_MODE_EDGE_CLAMP	Always ignore the border, texels at or near the edge of the texure are used for texturing
WRAP_MODE_BORDER_CLAMP	Clamp to the border colour when outside the texture coordinate range.
WRAP_MODE_MIRROR_REPEAT	Repeat but mirror every second multiple of the texture coordinates range. Texture may appear up-right in coordinate range[0,1] but upside-down in coordinate range[1,2]

Member Function Documentation

StreaminformationImage OpenCMISS::Zinc::FieldImage::createStreaminformationImage ( )

inline

Creates a stream information object for specifying files/resources and options for reading and writing image data to/from an image field.

Returns: Handle to new stream information, or NULL/invalid handle on failure.

CombineMode OpenCMISS::Zinc::FieldImage::getCombineMode ( )

inline

Returns how the image is combined with the material: blend, decal or modulate.

Returns: Returns enum describing how the image is combined with the material.

int OpenCMISS::Zinc::FieldImage::getDepthInPixels ( )

inline

Get the depth of the image.

Returns: depth of the image

Field OpenCMISS::Zinc::FieldImage::getDomainField ( )

inline

Gets the domain field on which texture coordinates must be specified to evaluate the image.

See also: Fieldcache::setFieldReal

Returns: Handle to the domain field, or NULL/invalid handle on failure.

FilterMode OpenCMISS::Zinc::FieldImage::getFilterMode ( )

inline

Returns how the image is rasterised onto the screen.

Returns: Returns enum describing how the image is rasterised onto the screen.

HardwareCompressionMode OpenCMISS::Zinc::FieldImage::getHardwareCompressionMode ( )

inline

Returns how the image is stored in graphics memory.

Returns: Returns enum describing how the image is stored in graphics memory.

int OpenCMISS::Zinc::FieldImage::getHeightInPixels ( )

inline

Get the height of the image.

Returns: height of the image

char* OpenCMISS::Zinc::FieldImage::getProperty ( const char * property )

inline

Gets the property named in the given property string from the given field image. The returned string must be deallocated by the receiver.

Parameters

image	The image field.
property	The property to retrieve.

Returns: null if it fails, else an allocated string containing the properties value.

int OpenCMISS::Zinc::FieldImage::getSizeInPixels	(	int	valuesCount,
		int *	valuesOut
	)

inline

Get the image size/resolution in pixels.

Parameters

valuesCount	The size of the valuesOut array to fill, from 1 to 3. Values for dimensions beyond this size have the value of 1.
valuesOut	Array to receive pixel sizes.

Returns: The actual dimension of the image, or 0 on error. This can be more than valuesCount, in which case a second call with a larger array is needed.

double OpenCMISS::Zinc::FieldImage::getTextureCoordinateDepth ( )

inline

Get the physical depth of the image.

Returns: physical depth of the image

double OpenCMISS::Zinc::FieldImage::getTextureCoordinateHeight ( )

inline

Get the physical height of the image.

Returns: physical height of the image

int OpenCMISS::Zinc::FieldImage::getTextureCoordinateSizes	(	int	valuesCount,
		double *	valuesOut
	)

inline

Gets the texture coordinate size to be used for this image field.

See also: FieldImage::setTextureCoordinateSizes

Parameters

valuesCount	The size of the sizes array to fill. Up to 3 values can be requested corresponding to width, height, depth.
valuesOut	Array to receive texture coordinate sizes.

Returns: OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT;

double OpenCMISS::Zinc::FieldImage::getTextureCoordinateWidth ( )

inline

Get the physical width of the image.

Returns: physical width of the image

int OpenCMISS::Zinc::FieldImage::getWidthInPixels ( )

inline

Get the width of the image.

Returns: width of the image

WrapMode OpenCMISS::Zinc::FieldImage::getWrapMode ( )

inline

Returns the mode describing how the image is wrapped outside the range [0,1].

Returns: Returns enum describing how the image is wrapped.

int OpenCMISS::Zinc::FieldImage::read ( const StreaminformationImage & streaminformationImage )

inline

Reads image data into the field. The streaminformation may specify a filename, series of filenames or a memory block reference to read from. If the format specified in the streaminformation is a "raw" format (such as rgb or gray) which does not embed information about the pixel storage then the data size is expected to be supplied in the streaminformation parameter.

Parameters

streaminformationImage Derived information about the supplied formatted image data. At a minimum it should specify either a filename or a memory resource.

Returns: Status OpenCMISS::Zinc::OK if the operation is successful, any other value on failure.

int OpenCMISS::Zinc::FieldImage::readFile ( const char * fileName )

inline

Convenient function to read a file with the provided name into a field image directly.

Parameters

fileName name of the file to read from.

Returns: Status OpenCMISS::Zinc::OK if data successfully read and merged into specified region, any other value on failure.

int OpenCMISS::Zinc::FieldImage::setCombineMode ( CombineMode combineMode )

inline

Sets how the image is combined with the material: blend, decal or modulate.

Parameters

combineMode Enumerator describing how the image is combined with the material.

Returns: Status OpenCMISS::Zinc::OK on success, any other value on failure.

int OpenCMISS::Zinc::FieldImage::setDomainField ( const Field & domainField )

inline

Sets the domain field on which texture coordinates must be specified to evaluate the image.

See also: Fieldcache::setFieldReal

Parameters

domainField The new domain field. Must be real-valued with at least as many components as the image dimension.

Returns: Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

int OpenCMISS::Zinc::FieldImage::setFilterMode ( FilterMode filterMode )

inline

Indicate to the graphics hardware how you would like the image rasterised onto the screen.

Parameters

filterMode Enumerator describing how the graphics hardware rasterises the texture onto the screen.

Returns: Status OpenCMISS::Zinc::OK on success, any other value on failure.

int OpenCMISS::Zinc::FieldImage::setHardwareCompressionMode ( HardwareCompressionMode hardwareCompressionMode )

inline

Indicate to the graphics hardware how you would like the texture stored in graphics memory.

Parameters

hardwareCompressionMode Enumerator describing how the image is combined with the material.

Returns: Status OpenCMISS::Zinc::OK on success, any other value on failure.

int OpenCMISS::Zinc::FieldImage::setSizeInPixels	(	int	valuesCount,
		const int *	valuesIn
	)

inline

Set the image size/resolution in pixels. Images from source are recomputed when next used. Otherwise the contents of the buffer are unchanged if the new size matches the previous size, or undefined if different. For images from source: after successful call to this function the image field maintains an independent resolution from any source image; up until then it maintains the same resolution as the source image.

Parameters

valuesCount	The size of the sizes array, giving the dimension of the image, from 1 to 3.
valuesIn	The resolution to set for each dimension, all >= 1.

Returns: Standard result code.

int OpenCMISS::Zinc::FieldImage::setTextureCoordinateDepth ( double depth )

inline

Set the texture coordinate depth of the image.

Parameters

depth Positive physical depth to be set for the image.

Returns: CMISS_OK if set correctly, any other value otherwise.

int OpenCMISS::Zinc::FieldImage::setTextureCoordinateHeight ( double height )

inline

Set the texture coordinate height of the image.

Parameters

height Positive physical height to be set for the image.

Returns: CMISS_OK if set correctly, any other value otherwise.

int OpenCMISS::Zinc::FieldImage::setTextureCoordinateSizes	(	int	valuesCount,
		const double *	valuesIn
	)

inline

Sets the texture coordinate size to be used for this image field.

See also: FieldImage::getTextureCoordinateSizes

Parameters

valuesCount	The size of the sizes array to fill. Up to 3 values can be set corresponding to width, height, depth.
valuesIn	Array containing texture coordinate sizes.

Returns: Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

int OpenCMISS::Zinc::FieldImage::setTextureCoordinateWidth ( double width )

inline

Set the texture coordinate width of the image.

Parameters

width Positive physical width to be set for the image.

Returns: CMISS_OK if set correctly, any other value otherwise.

int OpenCMISS::Zinc::FieldImage::setWrapMode ( WrapMode wrapMode )

inline

Set the mode describing how the image is wrapped outside the range [0,1].

Parameters

wrapMode Enumerator describing how image is wrapped outside the range [0,1].

Returns: Status OpenCMISS::Zinc::OK on success, any other value on failure.

int OpenCMISS::Zinc::FieldImage::write ( const StreaminformationImage & streaminformationImage )

inline

Writes a formatted representation of the image data. The streaminformation is used to control the formatted output. If a memory block reference has been specified to the io_stream then this will be allocated and set and the corresponding memory block length set. Otherwise the routine will try to write to the filename set on the storage information. The routine should fail if the values specified in the streaminformation cannot be respected. If one or two of the size parameters are set on the streaminformation then other dimensions will be adjusted to maintain aspect ratio and then the image is resized just for this output.

Parameters

streaminformationImage Information specifying the required format for the returned formatted image data.

Returns: Status OpenCMISS::Zinc::OK if the operation is successful, any other value on failure.

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

auto_comments_output/fieldimage.hpp
auto_comments_output/streamimage.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation