#include <mobu-python-api.h>

Class Description

Image class.

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

Inheritance diagram for FBImage:

Public Member Functions
	__reduce__ ()

	Cleanup (FBImage arg1)
	Cleanup image data, making it black. More...

	__init__ (object arg1, str arg2)
	Constructor. More...

bool	ConvertFormat (FBImage arg1, FBImageFormat arg2)
	Convert the image data format to another format. More...

bool	ConvertSize (FBImage arg1, object arg2, object arg3)
	Convert the image size. More...

	FBDelete (FBImage arg1)
	Virtual FBDelete function. More...

bool	Init (FBImage arg1, FBImageFormat arg2, object arg3, object arg4)
	Init. More...

bool	IsCompressedTif (FBImage arg1, str arg2)
	Query TIF file about its compressed status. More...

	VerticalFlip (FBImage arg1)
	Flip the image vertically. More...

bool	WriteToTif (FBImage arg1, str arg2, str arg3, object arg4)
	Write image data to a TIF file on disk. More...

int	GetBufferAddress (FBImage arg1)
	Access image data buffer, allow modifications. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

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

FBPropertyImageFormat	Format
	Read Write Property: Image data format. More...

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

FBPropertyImageInterleaveType	InterleaveType
	Read Only Property: Image interleave type. More...

FBPropertyImageInterpolationType	InterpolationType
	Read Only Property: Image interpolation type. More...

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

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

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None

C++ Signature:

 FBImage(const char * pFileName, HIObject pObject = ((void *) 0))

Parameters

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

See the C++ reference

__reduce__ ( )

Cleanup ( FBImage arg1 )

Cleanup image data, making it black.

Python Docstring:

Cleanup( (FBImage)arg1) -> None

C++ Signature:

void Cleanup()

See the C++ reference

bool ConvertFormat	(	FBImage	arg1,
		FBImageFormat	arg2
	)

Convert the image data format to another format.

Python Docstring:

ConvertFormat( (FBImage)arg1, (FBImageFormat)arg2) -> bool

C++ Signature:

bool ConvertFormat(FBImageFormat pNewFormat)

Parameters

pNewFormat The new format to convert the image to.

Returns: Return true if the convert was successful.

See the C++ reference

bool ConvertSize	(	FBImage	arg1,
		object	arg2,
		object	arg3
	)

Convert the image size.

Python Docstring:

ConvertSize( (FBImage)arg1, (object)arg2, (object)arg3) -> bool

C++ Signature:

bool ConvertSize(int pWidth, int pHeight)

Parameters

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

Returns: Return true if the convert was successful.

See the C++ reference

FBDelete ( FBImage arg1 )

Virtual FBDelete function.

Python Docstring:

FBDelete( (FBImage)arg1) -> None

C++ Signature:

void FBDelete()

See the C++ reference

int GetBufferAddress ( FBImage arg1 )

Access image data buffer, allow modifications.

Python Docstring:

GetBufferAddress( (FBImage)arg1) -> int

C++ Signature:

unsigned char * GetBufferAddress()

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

See the C++ reference

bool Init	(	FBImage	arg1,
		FBImageFormat	arg2,
		object	arg3,
		object	arg4
	)

Init.

Python Docstring:

Init( (FBImage)arg1, (FBImageFormat)arg2, (object)arg3, (object)arg4) -> bool

C++ Signature:

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

Parameters

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

See the C++ reference

bool IsCompressedTif	(	FBImage	arg1,
		str	arg2
	)

Query TIF file about its compressed status.

Python Docstring:

IsCompressedTif( (FBImage)arg1, (str)arg2) -> bool

C++ Signature:

bool IsCompressedTif(const char * pFileName)

Parameters

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

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

See the C++ reference

VerticalFlip ( FBImage arg1 )

Flip the image vertically.

Python Docstring:

VerticalFlip( (FBImage)arg1) -> None

C++ Signature:

void VerticalFlip()

See the C++ reference

bool WriteToTif	(	FBImage	arg1,
		str	arg2,
		str	arg3,
		object	arg4
	)

Write image data to a TIF file on disk.

Python Docstring:

WriteToTif( (FBImage)arg1, (str)arg2, (str)arg3, (object)arg4) -> bool

C++ Signature:

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

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.