r3uimage
real/code/r3uimage.h
r3code
UserImage Class
r3Ttag
R3CLID_TTAG
r3Userimage
R3CLID_USERIMAGE - 538
LOADIMAGE, UNLOADIMAGE, ENUMCHANNELS, ENUMCB, RELOADIMAGE, AUTOINDEXRANGE,
ImageFile, Image, Frame, AlsoChangesObj, AlsoChangesMethod, TextureAnimation, Type, BaseName, BaseIndex, TileAnimation, FlipAnimation, ReverseAnimation, NumFrames, Format, FormatType, FormatDigits, FormatName, PixelAspect,
int R3RegisterUserImageClass(R3APP *app);
R3UIMGM_LOADIMAGE
LOADIMAGE
R3UIMGM_LOADIMAGE
R3OBJ*, address of R3CLID_RAWIMAGE datatype object
rc = obj.LOADIMAGE();
reads the image data into ram memory. The returned image remains valid only while the image library is locked.
R3UIMGM_UNLOADIMAGE
UNLOADIMAGE
R3UIMGM_UNLOADIMAGE
obj.UNLOADIMAGE();
Ends use of the loaded RAM image. Image will be freed in the next image cache flush unless it is used by other systems.
R3UIMGM_ENUMCHANNELS
ENUMCHANNELS
R3UIMGM_ENUMCHANNELS
obj.ENUMCHANNELS();
Enumerates associated channel names as successive calls: * R3DoA3(cbobj, cbmth, void *callback_context, char *name)
R3UIMGM_ENUMCB
ENUMCB
R3UIMGM_ENUMCB
obj.ENUMCB();
R3UIMGM_RELOADIMAGE
RELOADIMAGE
R3UIMGM_RELOADIMAGE
R3OBJ*, new image or NULL if loading failed
R3BOOL, disable R3MM_CHANGED
rc = obj.RELOADIMAGE(p1, 0);
Ask system to reload the image.
R3UIMGM_AUTOINDEXRANGE
AUTOINDEXRANGE
R3UIMGM_AUTOINDEXRANGE
obj.AUTOINDEXRANGE();
Find image animation index range automatically
ImageFile
ImageFile
R3UIMGA_ImageFile
String
char[]
name of the image file. Note: RM_GET copies to the given buffer of R3PATH_LENGTH chars. It does not return the address of the name string.
jsobj.SetImageFile(value);
value = jsobj.GetImageFile();
char[] value = ...;
R3SetAttrs(r3obj, R3UIMGA_ImageFile, value, R3TAG_END);
char[] value;
R3GetAttrs(r3obj, R3UIMGA_ImageFile, &value, R3TAG_END);
Image
Image
R3UIMGA_Image
Object
R3OBJ*
image object
value = jsobj.GetImage();
R3OBJ* value;
R3GetAttrs(r3obj, R3UIMGA_Image, &value, R3TAG_END);
Frame
Frame
R3UIMGA_Frame
Integer
R3INT
frame index
jsobj.SetFrame(value);
value = jsobj.GetFrame();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_Frame, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_Frame, &value, R3TAG_END);
AlsoChangesObj
AlsoChangesObj
R3UIMGA_AlsoChangesObj
Object
R3OBJ*
callback, private
jsobj.SetAlsoChangesObj(value);
value = jsobj.GetAlsoChangesObj();
R3OBJ* value = ...;
R3SetAttrs(r3obj, R3UIMGA_AlsoChangesObj, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3UIMGA_AlsoChangesObj, &value, R3TAG_END);
AlsoChangesMethod
AlsoChangesMethod
R3UIMGA_AlsoChangesMethod
Integer
R3INT
callback method, private
jsobj.SetAlsoChangesMethod(value);
value = jsobj.GetAlsoChangesMethod();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_AlsoChangesMethod, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_AlsoChangesMethod, &value, R3TAG_END);
TextureAnimation
TextureAnimation
R3UIMGA_TextureAnimation
Integer
R3INT
see texture animation methods below
jsobj.SetTextureAnimation(value);
value = jsobj.GetTextureAnimation();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_TextureAnimation, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_TextureAnimation, &value, R3TAG_END);
Type
Type
R3UIMGA_Type
Integer
R3INT
read only, see animation file types below
value = jsobj.GetType();
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_Type, &value, R3TAG_END);
BaseName
BaseName
R3UIMGA_BaseName
String
char[]
unformatted file name. Note: RM_GET copies to given buffer
jsobj.SetBaseName(value);
value = jsobj.GetBaseName();
char[] value = ...;
R3SetAttrs(r3obj, R3UIMGA_BaseName, value, R3TAG_END);
char[] value;
R3GetAttrs(r3obj, R3UIMGA_BaseName, &value, R3TAG_END);
BaseIndex
BaseIndex
R3UIMGA_BaseIndex
Integer
R3INT
base index for texture animation
jsobj.SetBaseIndex(value);
value = jsobj.GetBaseIndex();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_BaseIndex, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_BaseIndex, &value, R3TAG_END);
TileAnimation
TileAnimation
R3UIMGA_TileAnimation
Boolean
R3BOOL
tile animation to be used as a texture map
jsobj.SetTileAnimation(value);
value = jsobj.GetTileAnimation();
R3BOOL value = ...;
R3SetAttrs(r3obj, R3UIMGA_TileAnimation, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3UIMGA_TileAnimation, &value, R3TAG_END);
FlipAnimation
FlipAnimation
R3UIMGA_FlipAnimation
Boolean
R3BOOL
if tiling, flip every odd sequence
jsobj.SetFlipAnimation(value);
value = jsobj.GetFlipAnimation();
R3BOOL value = ...;
R3SetAttrs(r3obj, R3UIMGA_FlipAnimation, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3UIMGA_FlipAnimation, &value, R3TAG_END);
ReverseAnimation
ReverseAnimation
R3UIMGA_ReverseAnimation
Boolean
R3BOOL
play texture animation in reversed order
jsobj.SetReverseAnimation(value);
value = jsobj.GetReverseAnimation();
R3BOOL value = ...;
R3SetAttrs(r3obj, R3UIMGA_ReverseAnimation, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3UIMGA_ReverseAnimation, &value, R3TAG_END);
NumFrames
NumFrames
R3UIMGA_NumFrames
Integer
R3INT
number of frames in the texture animation
jsobj.SetNumFrames(value);
value = jsobj.GetNumFrames();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_NumFrames, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_NumFrames, &value, R3TAG_END);
Format
Format
R3UIMGA_Format
String
char[]
indexing format string. Note: RM_GET copies to buffer of LEN_STRBUF chars
jsobj.SetFormat(value);
value = jsobj.GetFormat();
char[] value = ...;
R3SetAttrs(r3obj, R3UIMGA_Format, value, R3TAG_END);
char[] value;
R3GetAttrs(r3obj, R3UIMGA_Format, &value, R3TAG_END);
FormatType
FormatType
R3UIMGA_FormatType
Integer
R3INT
see format types below
jsobj.SetFormatType(value);
value = jsobj.GetFormatType();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_FormatType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_FormatType, &value, R3TAG_END);
FormatDigits
FormatDigits
R3UIMGA_FormatDigits
Integer
R3INT
number of digits
jsobj.SetFormatDigits(value);
value = jsobj.GetFormatDigits();
R3INT value = ...;
R3SetAttrs(r3obj, R3UIMGA_FormatDigits, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3UIMGA_FormatDigits, &value, R3TAG_END);
FormatName
FormatName
R3UIMGA_FormatName
String
char*
read only. ImageFile = sprintf(buf, FormatName, frameindex)
value = jsobj.GetFormatName();
char* value;
R3GetAttrs(r3obj, R3UIMGA_FormatName, &value, R3TAG_END);
PixelAspect
PixelAspect
R3UIMGA_PixelAspect
Number
R3FLOAT
aspect ration defined as h/w
jsobj.SetPixelAspect(value);
value = jsobj.GetPixelAspect();
R3FLOAT value = ...;
R3SetAttrs(r3obj, R3UIMGA_PixelAspect, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3UIMGA_PixelAspect, &value, R3TAG_END);
animation types
Format types
r3appobj *