SoImage Class

SoImage Class

Displays an image that always faces the camera.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoShape
              OIV.Inventor.NodesSoImage

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoImage : SoShape

Public Class SoImage
	Inherits SoShape

public ref class SoImage : public SoShape

type SoImage =  
    class
        inherit SoShape
    end

The SoImage type exposes the following members.

Constructors

	Name	Description
	SoImage	Constructor.

Top

Methods

	Name	Description
	AffectsState	Overrides default method on OIV.Inventor.Nodes.SoNode. (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes)	Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)	These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. (Inherited from SoShape.)
	Callback	Implements primitive generation for all shapes. (Inherited from SoShape.)
	ComputeBBox(SoAction, SbBox3f, SbVec3f)	Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an OIV.Inventor.Actions.SoGetBoundingBoxAction). (Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
	ComputeBBox(SoAction, SbXfBox3d, SbVec3d)	Compute object oriented bounding box (OOB) for subclass using information in the given action (which may not necessarily be an OIV.Inventor.Actions.SoGetBoundingBoxAction). (Inherited from SoShape.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoNode.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	EndShape	end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). (Inherited from SoShape.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method. (Inherited from SoShape.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	Counts number of primitives produced by this shape. (Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetShapeType	Gets the current shape Full Scene Antialiasing type. (Inherited from SoShape.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	Implements rendering by rendering each primitive generated by subclass. (Overrides SoShapeGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoNode.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Used by BoundingBoxAction to know if bounding box computation should be ignored or not. (Inherited from SoShape.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	Implements picking along a ray by intersecting the ray with each primitive generated by subclass. (Overrides SoShapeRayPick(SoRayPickAction).)
	Search	(Inherited from SoNode.)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetShapeType	set the antialiasing type for this shape. (Inherited from SoShape.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ShapeVertex	add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). (Inherited from SoShape.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoShape.)
	filename	Names file from which to read image.
	height	Height of image in pixels (optional).
	horAlignment	Horizontal alignment.
	image	Contains an in-memory representation of the image.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	vertAlignment	Vertical alignment.
	width	Width of image in pixels (optional).

Top

Remarks

The OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.SoImage.filename field. Once the image has been read, the OIV.Inventor.Nodes.SoImage.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 OIV.Inventor.Nodes.SoImage.filename field to an empty string ("").

Images can also be specified in memory by setting the OIV.Inventor.Nodes.SoImage.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 OIV.Inventor.Nodes.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. OIV.Inventor.Nodes.SoImage nodes prohibit auto-caching, so that no OIV.Inventor.Nodes.SoSeparator (or other render caching node) above an OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.SoSeparator.

Note that OIV.Inventor.Nodes.SoImage does not cast a shadow (OIV.Inventor.Nodes.SoShadowGroup).

Shape Antialiasing type is OIV.Inventor.Nodes.SoShape.ShapeTypes.POINTS.

FILE FORMAT/DEFAULT

Image {
filename " "
image 0 0 0
horAlignment LEFT
vertAlignment BOTTOM
width -1
height -1
}

ACTION BEHAVIOR

OIV.Inventor.Actions.SoGLRenderAction Draws the image parallel to the screen.

OIV.Inventor.Actions.SoRayPickAction Picks the image based on the current transformation and view.

OIV.Inventor.Actions.SoGetPrimitiveCountAction Increments the number of images by 1.

Reference

OIV.Inventor.Nodes Namespace

OIV.Inventor.Nodes.SoFullSceneAntialiasing

OIV.Inventor.Nodes.SoMarkerSet

OIV.Inventor.Nodes.SoTexture2

filename	" "
image	0 0 0
horAlignment	LEFT
vertAlignment	BOTTOM
width	-1
height	-1