.TH "SoImage" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoImage \- The \fBSoImage\fP class draws a 2D image on the viewport\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/nodes/SoImage\&.h>\fP
.PP
Inherits \fBSoShape\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBVertAlignment\fP { \fBBOTTOM\fP, \fBHALF\fP, \fBTOP\fP }"
.br
.ti -1c
.RI "enum \fBHorAlignment\fP { \fBLEFT\fP, \fBCENTER\fP, \fBRIGHT\fP }"
.br
.in -1c

Public Types inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "enum \fBTriangleShape\fP { \fBTRIANGLE_STRIP\fP, \fBTRIANGLE_FAN\fP, \fBTRIANGLES\fP, \fBPOLYGON\fP, \fBQUADS\fP, \fBQUAD_STRIP\fP, \fBPOINTS\fP, \fBLINES\fP, \fBLINE_STRIP\fP }"
.br
.in -1c

Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoImage\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.in -1c

Public Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP SbBool \fBaffectsState\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoBoundingBoxCache\fP * \fBgetBoundingBoxCache\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetOverride\fP (\fBconst\fP SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetNodeType\fP (\fBconst\fP \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBcopy\fP (SbBool \fBcopyconnections\fP=FALSE) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsSetup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsCleanup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoChildList\fP * \fBgetChildren\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteInstance\fP (\fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBaddToCopyDict\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBSoFieldContainer\fP *from, SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetToDefaults\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (\fBconst\fP \fBSoFieldContainer\fP *container) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyFieldValues\fP (\fBconst\fP \fBSoFieldContainer\fP *container, SbBool \fBcopyconnections\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBconst\fP fielddata)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetAllFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetField\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventIn\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventOut\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (\fBconst\fP \fBSoField\fP *\fBconst\fP \fBfield\fP, \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *\fBfield\fP, \fBvoid\fP *\fBnewval\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetFieldsMemorySize\fP (size_t &\fBmanaged\fP, size_t &\fBunmanaged\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetUserData\fP (\fBvoid\fP *userdata) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP * \fBgetUserData\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunrefNoDelete\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "\fBvirtual\fP \fBSbName\fP \fBgetName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetName\fP (\fBconst\fP \fBSbName\fP &\fBnewname\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoAuditorList\fP & \fBgetAuditors\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBassertAlive\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetScreenSize\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP \fBSbBox3f\fP &boundingbox, \fBSbVec2s\fP &\fBrectsize\fP)"
.br
.ti -1c
.RI "\fBstatic\fP float \fBgetDecimatedComplexity\fP (\fBSoState\fP *state, float complexity)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoNode\fP * \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name, \fBSoNodeList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBgetNextNodeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetActionMethodIndex\fP (\fBconst\fP \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitCopyDict\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBcheckCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBfindCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcopyDone\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBremoveName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBdecrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoBase\fP * \fBgetNamedBase\fP (\fBconst\fP \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNamedBases\fP (\fBconst\fP \fBSbName\fP &name, \fBSoBaseList\fP &\fBbaselist\fP, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP \fBexpectedtype\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetInstancePrefix\fP (\fBconst\fP \fBSbString\fP &c)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetTraceRefs\fP (SbBool \fBtrace\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBgetTraceRefs\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &\fBfromnodename\fP, \fBconst\fP \fBSbName\fP &\fBfromfieldname\fP, \fBconst\fP \fBSbName\fP &\fBtonodename\fP, \fBconst\fP \fBSbName\fP &\fBtofieldname\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFInt32\fP \fBwidth\fP"
.br
.ti -1c
.RI "\fBSoSFInt32\fP \fBheight\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBvertAlignment\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBhorAlignment\fP"
.br
.ti -1c
.RI "\fBSoSFImage\fP \fBimage\fP"
.br
.ti -1c
.RI "\fBSoSFString\fP \fBfilename\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoFieldData\fP * \fBgetFieldData\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoImage\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgeneratePrimitives\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcomputeBBox\fP (\fBSoAction\fP *action, \fBSbBox3f\fP &\fBbox\fP, \fBSbVec3f\fP &center)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadInstance\fP (\fBSoInput\fP *\fBin\fP, \fBunsigned\fP short flags)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBlist\fP)"
.br
.ti -1c
.RI "int \fBgetReadStatus\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetReadStatus\fP (SbBool \fBflag\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBSoShape\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoShape\fP ()"
.br
.ti -1c
.RI "float \fBgetComplexityValue\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBshouldGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBbeginSolidShape\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBendSolidShape\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBGLRenderBoundingBox\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "SbBool \fBshouldPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "SbBool \fBshouldRayPick\fP (\fBSoRayPickAction\fP *\fBconst\fP action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcomputeObjectSpaceRay\fP (\fBSoRayPickAction\fP *\fBconst\fP action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcomputeObjectSpaceRay\fP (\fBSoRayPickAction\fP *\fBconst\fP action, \fBconst\fP \fBSbMatrix\fP &matrix)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcreateTriangleDetail\fP (\fBSoRayPickAction\fP *action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv2\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv3\fP, \fBSoPickedPoint\fP *\fBpp\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcreateLineSegmentDetail\fP (\fBSoRayPickAction\fP *action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv2\fP, \fBSoPickedPoint\fP *\fBpp\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcreatePointDetail\fP (\fBSoRayPickAction\fP *action, \fBconst\fP \fBSoPrimitiveVertex\fP *v, \fBSoPickedPoint\fP *\fBpp\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBinvokeTriangleCallbacks\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv2\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv3\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBinvokeLineSegmentCallbacks\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv2\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBinvokePointCallbacks\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP v)"
.br
.ti -1c
.RI "\fBvoid\fP \fBbeginShape\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBTriangleShape\fP \fBshapetype\fP, \fBSoDetail\fP *\fBconst\fP detail=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBshapeVertex\fP (\fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP v)"
.br
.ti -1c
.RI "\fBvoid\fP \fBendShape\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgenerateVertex\fP (\fBSoPrimitiveVertex\fP *\fBconst\fP \fBpv\fP, \fBconst\fP \fBSbVec3f\fP &point, \fBconst\fP SbBool \fBuseTexFunc\fP, \fBconst\fP \fBSoMultiTextureCoordinateElement\fP *\fBconst\fP \fBtce\fP, \fBconst\fP float s, \fBconst\fP float t, \fBconst\fP \fBSbVec3f\fP &normal)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgenerateVertex\fP (\fBSoPrimitiveVertex\fP *\fBconst\fP \fBpv\fP, \fBconst\fP \fBSbVec3f\fP &point, \fBconst\fP SbBool \fBuseTexFunc\fP, \fBconst\fP \fBSoMultiTextureCoordinateElement\fP *\fBconst\fP \fBtce\fP, \fBconst\fP float s, \fBconst\fP float t, \fBconst\fP float r, \fBconst\fP \fBSbVec3f\fP &normal)"
.br
.ti -1c
.RI "SbBool \fBstartVertexArray\fP (\fBSoGLRenderAction\fP *action, \fBconst\fP \fBSoCoordinateElement\fP *coords, \fBconst\fP \fBSbVec3f\fP *\fBpervertexnormals\fP, \fBconst\fP SbBool \fBtexpervertex\fP, \fBconst\fP SbBool colorpervertex)"
.br
.ti -1c
.RI "\fBvoid\fP \fBfinishVertexArray\fP (\fBSoGLRenderAction\fP *action, \fBconst\fP SbBool vbo, \fBconst\fP SbBool \fBnormpervertex\fP, \fBconst\fP SbBool \fBtexpervertex\fP, \fBconst\fP SbBool colorpervertex)"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoNode\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoBase\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdestroy\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisgroup\fP, SbBool \fBisengine\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwriteFooter\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP char * \fBgetFileFormatName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype, \fBconst\fP uint32_t \fBbitmask\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataLock\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataUnlock\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "\fBstatic\fP int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoImage\fP class draws a 2D image on the viewport\&. 

An image can be specified either by using the image field, or by specifying a filename\&. If width and/or height is specified, the image will be resized to match those values before it is displayed\&.
.PP
The current modelview matrix will be used to find the viewport position, and the image is rendered in that position, with z-buffer testing activated\&.
.PP
Here's a simple, standalone example on how to set up and show an \fBSoImage\fP:
.PP
.PP
.nf
#include <cstdlib>
#include <Inventor/Qt/SoQt\&.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer\&.h>
#include <Inventor/nodes/SoSeparator\&.h>
#include <Inventor/nodes/SoCamera\&.h>
#include <Inventor/nodes/SoCube\&.h>
#include <Inventor/nodes/SoImage\&.h>

static void
mandel(double sr, double si, double width, double height,
       int bwidth, int bheight, int mult, unsigned char * bmp, int n)
{
  double zr, zr_old, zi, cr, ci;
  int w;

  for (int y=0; y<bheight; y++)
    for (int x=0; x<bwidth; x++) {
      cr = ((double)(x)/(double)(bwidth))*width+sr;
      ci = ((double)(y)/(double)(bheight))*height+si;
      zr = zi = 0\&.0;
      for (w = 0; (w < n) && (zr*zr + zi*zi)<n; w++) {
        zr_old = zr;
        zr = zr*zr \- zi*zi + cr;
        zi = 2*zr_old*zi + ci;
      }
      bmp[y*bwidth+x] = w*mult;
    }
}

int
main(int argc, char ** argv)
{
  QWidget * mainwin = SoQt::init(argv[0]);

  SoSeparator * root = new SoSeparator;
  root\->ref();

  const int IMGWIDTH = 256;
  const int IMGHEIGHT = 256;
  unsigned char * img = new unsigned char[IMGWIDTH * IMGHEIGHT];
  mandel(\-0\&.5, 0\&.6, 0\&.025, 0\&.025, IMGWIDTH, IMGHEIGHT, 1, img, 256);

  SoImage * nimage = new SoImage;
  nimage\->vertAlignment = SoImage::HALF;
  nimage\->horAlignment = SoImage::CENTER;
  nimage\->image\&.setValue(SbVec2s(IMGWIDTH, IMGHEIGHT), 1, img);

  SoCube * cube = new SoCube;

  root\->addChild(cube);
  root\->addChild(nimage);

  SoQtExaminerViewer * viewer = new SoQtExaminerViewer(mainwin);
  viewer\->setSceneGraph(root);
  viewer\->setTitle("SoImage use");
  viewer\->show();

  SoCamera * cam = viewer\->getCamera();
  cam\->position = SbVec3f(0, 0, 50);
  cam\->focalDistance = 50;

  SoQt::show(mainwin);
  SoQt::mainLoop();

  delete viewer;
  root\->unref();
  delete img;
  return 0;
}
.fi
.PP
.PP
Note that an \fBSoImage\fP node in the scene graph will have its positioning / rendering influenced by the current viewport and camera\&. This has important implications for how to layout your scene graph for the best possible rendering performance\&. See the note about this issue in the \fBSoText2\fP class documentation\&.
.PP
\fBSoScale\fP nodes cannot be used to influence the dimensions of the rendering output of \fBSoImage\fP nodes\&.
.PP
\fBFILE FORMAT/DEFAULTS:\fP 
.PP
.nf
Image {
    width \-1
    height \-1
    vertAlignment BOTTOM
    horAlignment LEFT
    image 0 0 0

    filename ""
}

.fi
.PP
.PP
\fBSince\fP
.RS 4
TGS Inventor \fB2\&.5\fP 
.PP
Coin \fB1\&.0\fP 
.RE
.PP

.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBSoImage::VertAlignment\fP"
Vertical alignment for image\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIBOTTOM \fP\fP
Vertical alignment at bottom of image\&. 
.TP
\fB\fIHALF \fP\fP
Vertical alignment at center of image\&. 
.TP
\fB\fITOP \fP\fP
Vertical alignment at top of image\&. 
.SS "\fBenum\fP \fBSoImage::HorAlignment\fP"
Horizontal alignment for image\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fILEFT \fP\fP
Horizontal alignment at left border\&. 
.TP
\fB\fICENTER \fP\fP
Horizontal alignment at center of image\&. 
.TP
\fB\fIRIGHT \fP\fP
Horizontal alignment at right border\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoImage::SoImage (\fBvoid\fP)"
Constructor\&. 
.SS "SoImage::~SoImage ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoImage::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoImage::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBconst\fP \fBSoFieldData\fP ** SoImage::getFieldDataPtr (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.br
 
.SS "\fBconst\fP \fBSoFieldData\fP * SoImage::getFieldData (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoImage::initClass (\fBvoid\fP)\fC [static]\fP"

.SS "\fBvoid\fP SoImage::GLRender (\fBSoGLRenderAction\fP * action)\fC [virtual]\fP"
Action method for the \fBSoGLRenderAction\fP\&.
.PP
This is called during rendering traversals\&. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoImage::rayPick (\fBSoRayPickAction\fP * action)\fC [virtual]\fP"
Calculates picked point based on primitives generated by subclasses\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoImage::getPrimitiveCount (\fBSoGetPrimitiveCountAction\fP * action)\fC [virtual]\fP"
Action method for the \fBSoGetPrimitiveCountAction\fP\&.
.PP
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the \fIaction\fP\&.
.PP
Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoImage::generatePrimitives (\fBSoAction\fP * action)\fC [protected]\fP, \fC [virtual]\fP"
Will generate a textured quad, representing the image in 3D\&. 
.PP
Implements \fBSoShape\fP\&.
.SS "\fBvoid\fP SoImage::computeBBox (\fBSoAction\fP * action, \fBSbBox3f\fP & box, \fBSbVec3f\fP & center)\fC [protected]\fP, \fC [virtual]\fP"
Implemented by \fBSoShape\fP subclasses to let the \fBSoShape\fP superclass know the exact size and weighted center point of the shape's bounding box\&.
.PP
The bounding box and center point should be calculated and returned in the local coordinate system\&.
.PP
The method implements action behavior for shape nodes for \fBSoGetBoundingBoxAction\fP\&. It is invoked from \fBSoShape::getBoundingBox()\fP\&. (Subclasses should \fInot\fP override \fBSoNode::getBoundingBox()\fP\&.)
.PP
The \fIbox\fP parameter sent in is guaranteed to be an empty box, while \fIcenter\fP is undefined upon function entry\&. 
.PP
Implements \fBSoShape\fP\&.
.SS "SbBool SoImage::readInstance (\fBSoInput\fP * in, \fBunsigned\fP short flags)\fC [protected]\fP, \fC [virtual]\fP"
This method is mainly intended for internal use during file import operations\&.
.PP
It reads a definition of an instance from the input stream \fIin\fP\&. The input stream state points to the start of a serialized / persistent representation of an instance of this class type\&.
.PP
\fCTRUE\fP or \fCFALSE\fP is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not\&. The import process should be robust and handle corrupted input streams by returning \fCFALSE\fP\&.
.PP
\fIflags\fP is used internally during binary import when reading user extension nodes, group nodes or engines\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "\fBvoid\fP SoImage::notify (\fBSoNotList\fP * l)\fC [protected]\fP, \fC [virtual]\fP"
Notifies all auditors for this instance when changes are made\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "int SoImage::getReadStatus (\fBvoid\fP)\fC [protected]\fP"
Returns \fITRUE\fP if node was read OK\&. 
.SS "\fBvoid\fP SoImage::setReadStatus (SbBool flag)\fC [protected]\fP"
Set read status for this node\&. 
.SH "Member Data Documentation"
.PP 
.SS "\fBSoSFInt32\fP SoImage::width"
If bigger than 0, resize image to this width before rendering\&. Default value is -1 (i\&.e\&. 'don't resize')\&. 
.SS "\fBSoSFInt32\fP SoImage::height"
If bigger than 0, resize image to this height before rendering\&. Default value is -1 (i\&.e\&. 'don't resize')\&. 
.SS "\fBSoSFEnum\fP SoImage::vertAlignment"
Vertical alignment\&. Default value is \fBSoImage::BOTTOM\fP\&. 
.SS "\fBSoSFEnum\fP SoImage::horAlignment"
Horizontal alignment\&. Default value is \fBSoImage::LEFT\fP\&. 
.SS "\fBSoSFImage\fP SoImage::image"
Inline image data\&. Default empty\&. 
.SS "\fBSoSFString\fP SoImage::filename"
Image filename\&. Default empty\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.