PoSceneView Class

PoSceneView Class

Class to define a view which contains a scene.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.Inventor.Gui.ViewPoBaseView
                OIV.Inventor.Gui.ViewPoSceneView

Namespace: OIV.Inventor.Gui.View
Assembly: OIV.Inventor.Win (in OIV.Inventor.Win.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class PoSceneView : PoBaseView

Public Class PoSceneView
	Inherits PoBaseView

public ref class PoSceneView : public PoBaseView

type PoSceneView =  
    class
        inherit PoBaseView
    end

The PoSceneView type exposes the following members.

Constructors

	Name	Description
	PoSceneView	Default constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoBaseKit.)
	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.)
	CreatePathToPart(String, Boolean)	Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.)
	CreatePathToPart(String, Boolean, SoPath)	Returns a path that begins at this nodekit and ends at partName. (Inherited from SoBaseKit.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoBaseKit.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	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	(Inherited from SoBaseKit.)
	GetClassNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.
	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 SoBaseKit.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. (Inherited from SoBaseKit.)
	GetPart	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. (Inherited from SoBaseKit.)
	GetPartString	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. (Inherited from SoBaseKit.)
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetViewportIsEnabled	(Inherited from SoBaseKit.)
	GetViewportOrigin	(Inherited from SoBaseKit.)
	GetViewportSize	(Inherited from SoBaseKit.)
	GLRender	(Inherited from SoBaseKit.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoBaseKit.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. (Inherited from SoBaseKit.)
	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.)
	IsPointWithinViewport	Indicates if a point defined in the normalized space [0-1]x[0-1] is in the viewport of the view. (Inherited from PoBaseView.)
	IsSensitiveOnEvents	Returns true if the view is sensitive to events. (Inherited from PoBaseView.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoBaseKit.)
	Search	(Inherited from SoBaseKit.)
	SensitiveOnEvents	Specifies if the view is sensitive to events. (Inherited from PoBaseView.)
	Set(String)	This function allows field values of parts (nodes) to be set in several different parts simultaneously. (Inherited from SoBaseKit.)
	Set(String, String)	This function allows field values of parts (nodes) to be set. (Inherited from SoBaseKit.)
	SetCamera	Sets the camera of the view on the viewer. (Inherited from PoBaseView.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetPart	Inserts the given node (not a copy) as the new part specified by partName. (Inherited from SoBaseKit.)
	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.)
	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 SoBaseKit.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	isBackgroundVisible	Defines the visibility of the background of the view.
	isBorderVisible	Defines the visibility of the borders of the view.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	viewportOrigin	Lower-left corner coordinates of the viewport of the view. (Inherited from PoBaseView.)
	viewportSize	Size of the viewport of the view. (Inherited from PoBaseView.)

Top

Remarks

This class allows the user to define a view which contains a scene.

Views allow the application to specify multiple cameras, each with its own separate viewport (region of the 3D window). This is more powerful than just using multiple OIV.Inventor.Nodes.SoCamera nodes, because camera nodes do not allow specifying a viewport (the viewport is always the full window). See OIV.Inventor.Gui.View.PoBaseView for more explanation.

A scene is a set of any nodes (except OIV.Inventor.Nodes.SoCamera nodes) placed under an OIV.Inventor.Nodes.SoGroup node which must be seen in a viewport according to a camera configuration. To define a view, set the fields viewportOrigin and viewportSize according to the viewport position and size you want to have (relative to the display window sizes), configure the camera (set the part cameraKit), build the scene under an OIV.Inventor.Nodes.SoGroup node, and set this scene to the view (set the part scene). All shape nodes contained in the scene will be drawn in the viewport previously defined and according to the camera definition. You can define as many views as you want.

NOTES:

If you use a viewer, you should call the method SoBaseKit.setSearchingChildren(true) to allow the viewer to search for cameras inside nodekits (like this one).
Do not place a camera node before this nodekit.
Create a camera for each view and set it using the setPart method. See example.
When you use HardCopy, the graphics window is the paper sheet.
LIMITATIONS:
The field OIV.Inventor.Nodes.SoCamera.viewportMapping must be equal to ADJUST_CAMERA in order to have a correct vectorisation when you use HardCopy,
Do not use the OIV.Inventor.Actions.SoBoxHighlightRenderAction class on a scene graph which contains a view,
Do not push view,
Be careful when you use the method viewAll() of the class SoXtViewer, because this method works on the entire scene graph and not on a portion of a scene graph. Overload this method according to your requirements,
Some of the viewer functions/buttons do not work correctly with views. For example, saveHomePosition() and resetToHomePosition() do not work correctly because the viewer only stores one copy of the camera.
The viewer rendering options, e.g. wireframe, apply to ALL views inside the viewer. You can implement these effects per-view using an OIV.Inventor.Nodes.SoDrawStyle node and OIV.Inventor.Nodes.SoNode.SetOverride(System.Boolean) if necessary.
In case of tile rendering with OIV.Inventor.SoOffscreenRenderArea : OIV.Inventor.Nodes.SoGradientBackground in a OIV.Inventor.Gui.View.PoSceneView will not be rendered with the correct size (i.e. the OIV.Inventor.Nodes.SoGradientBackground size will not match the target size). Call SoOffscreenRenderArea.setTileSize() with the offscreen rendering total size to avoid this size problem.

EXAMPLE

Copy

SoBaseKit.SetSearchingChildren(true);

SoSeparator scene1 = new SoSeparator();
scene1.AddChild( new SoCone() );

PoSceneView view1 = new PoSceneView();
view1.SensitiveOnEvents(true);
view1.isBorderVisible.Value = true;
view1.viewportOrigin.SetValue(0, 0);
view1.viewportSize.SetValue(0.5f, 0.5f);
SoPerspectiveCamera cam1 = new SoPerspectiveCamera();
view1.SetPart("cameraKit.camera", cam1);
view1.SetPart("scene", scene1);
cam1.ViewAll(scene1, new SbViewportRegion(100, 100));
root.AddChild(view1);

SoSeparator scene2 = new SoSeparator();
scene2.AddChild( new SoCube() );

PoSceneView view2 = new PoSceneView();
view2.SensitiveOnEvents(true);
view2.isBorderVisible.Value = true;
view2.Set("borderApp.drawStyle", "lineWidth 1.5"); // Work-around for border
view2.viewportOrigin.SetValue(0.5f, 0.5f);
view2.viewportSize.SetValue(0.5f, 0.5f);
SoPerspectiveCamera cam2 = new SoPerspectiveCamera();
view2.SetPart("cameraKit.camera", cam2);
view2.SetPart("scene", scene2);
cam2.ViewAll(scene2, new SbViewportRegion(100, 100));
root.AddChild(view2);

viewer.SetSceneGraph(root);

FILE FORMAT/DEFAULT

OIV.Inventor.Gui.View.PoSceneView {
viewportOrigin 0 0
viewportSize 1 1
isBackgroundVisible false
isBorderVisible false
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading1265">CATALOG PARTS</A></h4> <ul>PoSceneView {</ul> <ul><ul>Separator <tt>topSep</tt> (from PoSceneView) { </ul></ul> <ul><ul><ul>Separator <tt>backgroundSep</tt> (from PoSceneView) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the background of the view.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>backgroundApp </tt>(from PoSceneView)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the background.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>background </tt>(from PoSceneView)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the background.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul></ul></ul> <ul><ul><ul>Separator <tt>sceneSep</tt> (from PoSceneView) {</ul></ul></ul> <ul><ul><ul>Contains the camera and the scene of the view specified by the user.</ul></ul></ul> <ul><ul><ul><ul>Camera <tt>cameraKit </tt>(from PoBaseView) </ul></ul></ul></ul> <ul><ul><ul><ul>Contains the camera of the view specified by the user.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>scene </tt>(from PoSceneView)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains the scene of the view specified by the user.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul></ul></ul> <ul><ul><ul>Separator <tt>borderSep</tt> (from PoSceneView) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the borders of the view.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>borderApp </tt>(from PoSceneView)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the borders.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>border </tt>(from PoSceneView)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw the borders.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>} </ul> </body> </html>

Reference

OIV.Inventor.Gui.View Namespace