Image class. More...

#include <fbimage.h>

Inheritance diagram for FBImage:

[legend]

Public Member Functions
	FBImage (const char *pFileName, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Virtual FBDelete function.

void	Cleanup ()
	Cleanup image data, making it black.

bool	Init (FBImageFormat pFormat, int pWidth, int pHeight)
	Init.

unsigned char *	GetBufferAddress ()
	Access image data buffer, allow modifications.

bool	ConvertFormat (FBImageFormat pNewFormat)
	Convert the image data format to another format.

bool	ConvertSize (int pWidth, int pHeight)
	Convert the image size.

void	VerticalFlip ()
	Flip the image vertically.

K_DEPRECATED_2024 bool	WriteToTif (const char pFileName, const char pComments, bool pCompressed)
	Write image data to a TIF file on disk.

bool	WriteToDisk (const char pFileName, const char pComments, int pQuality, int pCompressionType)
	Write image data to a file on disk.

K_DEPRECATED_2024 bool	IsCompressedTif (const char *pFileName)
	Query TIF file about its compressed status.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyInt	Width
	Read Write Property: Width of the image in pixels.

FBPropertyInt	Height
	Read Write Property: Height of the image in pixels.

FBPropertyInt	Depth
	Read Write Property: Color depth of the image.

FBPropertyImageFormat	Format
	Read Write Property: Image data format.

FBPropertyImageType	Type
	Read Only Property: Image type, refering to either frame or field.

FBPropertyImageInterleaveType	InterleaveType
	Read Only Property: Image interleave type. Only meaningful if image type is field.

FBPropertyImageInterpolationType	InterpolationType
	Read Only Property: Image interpolation type.

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Image class.

Utility class used to load and get manipulate image data from disk or memory.

Definition at line 104 of file fbimage.h.

Constructor & Destructor Documentation

◆ FBImage()

FBImage	(	const char *	pFileName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pFileName	Path to the image file. If pObject is not NULL, pFileName will be ignored.
pObject	For internal use only.

Member Function Documentation

◆ Cleanup()

void Cleanup ( )

Cleanup image data, making it black.

◆ ConvertFormat()

bool ConvertFormat ( FBImageFormat pNewFormat )

Convert the image data format to another format.

Parameters

pNewFormat The new format to convert the image to.

Returns: Return true if the convert was successful.

◆ ConvertSize()

bool ConvertSize	(	int	pWidth,
		int	pHeight
	)

Convert the image size.

Parameters

pWidth	New width of the image.
pHeight	New height of the image.

Returns: Return true if the convert was successful.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBComponent.

◆ GetBufferAddress()

unsigned char * GetBufferAddress ( )

Access image data buffer, allow modifications.

Returns: Pointer to the image data, values ranging from 0 to 255.

◆ Init()

bool Init	(	FBImageFormat	pFormat,
		int	pWidth,
		int	pHeight
	)

Init.

Parameters

pFormat	Image format used to initialize data buffer.
pWidth	Image width in pixels.
pHeight	Image height in pixels.

◆ IsCompressedTif()

K_DEPRECATED_2024 bool IsCompressedTif ( const char * pFileName )

Query TIF file about its compressed status.

Deprecated:: Will always return false.

Parameters

pFileName Full TIF file path name of the file to query.

Returns: Return true if the TIF file image data is compressed.

◆ VerticalFlip()

void VerticalFlip ( )

Flip the image vertically.

◆ WriteToDisk()

bool WriteToDisk	(	const char *	pFileName,
		const char *	pComments,
		int	pQuality,
		int	pCompressionType
	)

Write image data to a file on disk.

The image format used is determined by the file extension of the given filename.

Parameters

pFileName	Full file path name of the image file to write.
pComments	Comments appended to the file for image formats that support it.
pQuality	Quality of the image for image formats that support it. Depends on the image format. For "jpeg": 0-100 where 0=(low visual quality, high compression), 100=(high visual quality, low compression).
pCompressionType	Compression type of image for image formats that support it. Depends on the image format. For "tif": 0 = ( no compression ), 1 = ( LZW-compression ).

Returns: Return true if the image was successfully written on disk.

◆ WriteToTif()

K_DEPRECATED_2024 bool WriteToTif	(	const char *	pFileName,
		const char *	pComments,
		bool	pCompressed
	)

Write image data to a TIF file on disk.

Deprecated:: Use the WriteToDisk function instead.

Parameters

pFileName	Full TIF file path name of the file to write.
pComments	Comments appended to the TIF file.
pCompressed	If true, the image data in the file will be compressed.

Returns: Return true if the image was successfully written on disk.

Member Data Documentation

◆ Depth

FBPropertyInt Depth

Read Write Property: Color depth of the image.

Definition at line 181 of file fbimage.h.

◆ Format

FBPropertyImageFormat Format

Read Write Property: Image data format.

Definition at line 182 of file fbimage.h.

◆ Height

FBPropertyInt Height

Read Write Property: Height of the image in pixels.

Definition at line 180 of file fbimage.h.

◆ InterleaveType

FBPropertyImageInterleaveType InterleaveType

Read Only Property: Image interleave type. Only meaningful if image type is field.

Definition at line 184 of file fbimage.h.

◆ InterpolationType

FBPropertyImageInterpolationType InterpolationType

Read Only Property: Image interpolation type.

Definition at line 185 of file fbimage.h.

◆ Type

FBPropertyImageType Type

Read Only Property: Image type, refering to either frame or field.

Definition at line 183 of file fbimage.h.

◆ Width

FBPropertyInt Width

Read Write Property: Width of the image in pixels.

Definition at line 179 of file fbimage.h.

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

fbimage.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBImage()

Member Function Documentation

◆ Cleanup()

◆ ConvertFormat()

◆ ConvertSize()

◆ FBDelete()

◆ GetBufferAddress()

◆ Init()

◆ IsCompressedTif()

◆ VerticalFlip()

◆ WriteToDisk()

◆ WriteToTif()

Member Data Documentation

◆ Depth

◆ Format

◆ Height

◆ InterleaveType

◆ InterpolationType

◆ Type

◆ Width