public class SoImage extends SoShape
SoImage
node allows you to display an image without using the texture facilities. The image is a 2D image attached to a 3D justification point. The justification point is at (0,0,0) after applying the current transformation. The image is always parallel to the screen. The image is
not resized when the render window is resized.
The image can be read from the file specified by the filename
field. Once the image has been read, the image
field contains the image data. However, this field is marked so the image is not written out when the image node is written to a file. To turn off the image, set the filename
field to an empty string ("").
Images can also be specified in memory by setting the image
field to contain the image data. Doing so resets the file name to the empty string.
This node can be useful for placing a logo in the scene, or for attaching an icon or marker to a 3D point.
By default (or when the width and height fields are both set to negative values), the actual size of the image is used. If the width and/or height are specified, the image is scaled to the specified size in pixels.
Note that SoImage
automatically enables blending for 2 or 4 component images, but it does not set the blending function. However, if you have enabled transparency, or if any of the textures in your scene graph have 2 or 4 components, the blending function
will be set.
Note that the position of the image on the screen depends on the current camera settings, so generally this node should not be render cached. SoImage
nodes prohibit auto-caching, so that no SoSeparator
(or other render caching node) above an SoImage
in the scene graph will automatically create a render cache. This can significantly affect performance and applications should try to keep nodes that
can be render cached (especially geometry nodes) under a different SoSeparator
.
Note that SoImage
does not cast a shadow (SoShadowGroup
).
Shape Antialiasing type is SoShape.POINTS
.
File format/default:
Image {
filename | " " |
image | 0 0 0 |
horAlignment | LEFT |
vertAlignment | BOTTOM |
width | -1 |
height | -1 |
Action behavior:
SoGLRenderAction
Draws the image parallel to the screen.
SoRayPickAction
Picks the image based on the current transformation and view.
SoGetPrimitiveCountAction
Increments the number of images by 1.
See also:
Modifier and Type | Class and Description |
---|---|
static class |
SoImage.FileTypes
File type.
|
static class |
SoImage.HorAlignments
Horizontal alignment.
|
static class |
SoImage.VertAlignments
Vertical alignment.
|
SoShape.ShapeTypes
SoNode.RenderModes
Inventor.ConstructorCommand
Modifier and Type | Field and Description |
---|---|
SoSFFilePathString |
filename
Names file from which to read image.
|
SoSFInt32 |
height
Height of image in pixels (optional).
|
SoSFEnum<SoImage.HorAlignments> |
horAlignment
Horizontal alignment.
|
SoSFImage |
image
Contains an in-memory representation of the image.
|
SoSFEnum<SoImage.VertAlignments> |
vertAlignment
Vertical alignment.
|
SoSFInt32 |
width
Width of image in pixels (optional).
|
boundingBoxIgnoring
VERBOSE_LEVEL, ZeroHandle
Constructor and Description |
---|
SoImage()
Constructor.
|
getShapeType, isPrimitiveRestartAvailable, isPrimitiveRestartAvailable
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults
dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
getNativeResourceHandle
public final SoSFFilePathString filename
SoRasterImageRW
for the list. If the filename is not an absolute path name, the list of directories maintained by SoInput
is searched. If the texture is not found in any of those directories, then the file is searched for relative to the directory from which the SoImage
node was read. For example, if an SoImage
node with a filename of "../tofu.rgb" is read from /usr/people/bob/models/food.iv, then /usr/people/bob/tofu.rgb will be read (assuming tofu.rgb isn't found in the directories maintained by SoInput
).public final SoSFImage image
SoSFImage
.public final SoSFEnum<SoImage.HorAlignments> horAlignment
public final SoSFEnum<SoImage.VertAlignments> vertAlignment
public final SoSFInt32 width
public final SoSFInt32 height
Generated on July 31, 2019, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com