Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoViewport Class Reference

VSG extension Viewport parameters node. More...

#include <Inventor/nodes/SoViewport.h>

+ Inheritance diagram for SoViewport:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoViewport ()
 Constructor.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 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.
 
SbBool set (const SbString &fieldDataString)
 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.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFVec2f origin
 Specifies the position of the viewport in pixels.
 
SoSFVec2f size
 Specifies the size of the viewport in pixels.
 

Detailed Description

VSG extension Viewport parameters node.

This node specifies the viewport used for rendering.

The view volume specified by the current camera will be mapped into this region of the render target (e.g. the viewer window). By default Open Inventor manages the viewport to be the entire render target, even if the window (for example) is resized. So this node is useful for rendering objects in a specific part of the window, for example screen locked annotation graphics like legends and a "compass".

Remember that the camera node's viewportMapping field is set to ADJUST_CAMERA by default. In this mode the camera automatically adjusts its view volume to have the same aspect ratio as the viewport (widening for example) to avoid distorting shapes in the scene. But note that the camera will compare the aspect ratio of its view volume to the aspect ratio of the viewport that is in effect when the camera node is traversed. So it's generally better to create a camera for each viewport and make sure the camera node is traversed after the viewport node. If using multiple viewports with the same camera, generally the viewports should all have the aspect ratio.

Tip: You can use the SoDepthBuffer node to clear the depth buffer in the viewport region to ensure annotation graphics render correctly. However, in general, you should put an SoViewportClipping node before this node to limit the effect of the depth buffer clear to the desired viewport.

If you want to place multiple "views" inside the same window, consider the PoView and PoSceneView nodes. Views allow the application to specify multiple cameras, each with its own separate viewport
Views can be used, for example, to subdivide the window into multiple independent views of a 3D scene or to create an inset "bird's eye" view inside the window, without the overhead of creating separate windows. The advantage of using the view nodes over SoViewport is that when mouse event locations are mapped back into 3D space, Open Inventor automatically uses the view volume of the camera associated with the view node whose viewport currently contains the mouse cursor.

NOTE: node available since Open Inventor 8.6

FILE FORMAT/DEFAULT

    Viewport {
    origin (0,0)
    size (0,0)
    }

ACTION BEHAVIOR

SEE ALSO

SbViewportRegion, SoViewportClipping, SoDepthBuffer, PoView, PoSceneView

Definition at line 102 of file SoViewport.h.

Constructor & Destructor Documentation

◆ SoViewport()

SoViewport::SoViewport ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoViewport::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoViewport::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ origin

SoSFVec2f SoViewport::origin

Specifies the position of the viewport in pixels.

(Although this is a float field, the values really are pixels, not normalized units.) Default is 0,0.

Definition at line 113 of file SoViewport.h.

◆ size

SoSFVec2f SoViewport::size

Specifies the size of the viewport in pixels.

(Although this is a float field, the values really are pixels, not normalized units.) Default is 0,0.

Definition at line 120 of file SoViewport.h.


The documentation for this class was generated from the following file: