ViewportRegion Class Reference

The ViewportRegion class is used to specify a sub-viewport. More...

#include <Inventor/nodes/ViewportRegion.h>

Inherits SoNode.

Public Member Functions
	ViewportRegion (void)
virtual void	doAction (SoAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	pick (SoPickAction *action)
virtual void	callback (SoCallbackAction *action)
Public Member Functions inherited from SoNode
void	setOverride (const SbBool state)
SbBool	isOverride (void) const
void	setNodeType (const NodeType type)
NodeType	getNodeType (void) const
virtual SoNode *	copy (SbBool copyconnections=FALSE) const
virtual SbBool	affectsState (void) const
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
virtual void	write (SoWriteAction *action)
virtual void	audioRender (SoAudioRenderAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	grabEventsSetup (void)
virtual void	grabEventsCleanup (void)
virtual void	startNotify (void)
SbUniqueId	getNodeId (void) const
virtual SoChildList *	getChildren (void) const
virtual void	writeInstance (SoOutput *out)
virtual SoNode *	addToCopyDict (void) const
virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer *	copyThroughConnection (void) const
Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)
SbBool	hasDefaultValues (void) const
SbBool	fieldsAreEqual (const SoFieldContainer *container) const
void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
SbBool	set (const char *const fielddata)
void	get (SbString &fielddata)
virtual int	getFields (SoFieldList &l) const
virtual int	getAllFields (SoFieldList &l) const
virtual SoField *	getField (const SbName &name) const
virtual SoField *	getEventIn (const SbName &name) const
virtual SoField *	getEventOut (const SbName &name) const
SbBool	getFieldName (const SoField *const field, SbName &name) const
SbBool	enableNotify (const SbBool flag)
SbBool	isNotifyEnabled (void) const
SbBool	set (const char *fielddata, SoInput *input)
void	get (SbString &fielddata, SoOutput *out)
virtual SbBool	validateNewFieldValue (SoField *field, void *newval)
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool	getIsBuiltIn (void) const
virtual const SoFieldData *	getFieldData (void) const
virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
void	setUserData (void *userdata) const
void *	getUserData (void) const
Public Member Functions inherited from SoBase
void	ref (void) const
void	unref (void) const
void	unrefNoDelete (void) const
int32_t	getRefCount (void) const
void	touch (void)
virtual SoType	getTypeId (void) const=0
SbBool	isOfType (SoType type) const
virtual SbName	getName (void) const
virtual void	setName (const SbName &newname)
void	addAuditor (void *const auditor, const SoNotRec::Type type)
void	removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList &	getAuditors (void) const
SbBool	shouldWrite (void)
void	assertAlive (void) const

Static Public Member Functions
static void	initClass (void)
Static Public Member Functions inherited from SoNode
static uint32_t	getCompatibilityTypes (const SoType &nodetype)
static SoNode *	getByName (const SbName &name)
static int	getByName (const SbName &name, SoNodeList &l)
static void	initClasses (void)
static SbUniqueId	getNextNodeId (void)
static int	getActionMethodIndex (const SoType type)
static void	getBoundingBoxS (SoAction *action, SoNode *node)
static void	GLRenderS (SoAction *action, SoNode *node)
static void	callbackS (SoAction *action, SoNode *node)
static void	getMatrixS (SoAction *action, SoNode *node)
static void	handleEventS (SoAction *action, SoNode *node)
static void	pickS (SoAction *action, SoNode *node)
static void	rayPickS (SoAction *action, SoNode *node)
static void	searchS (SoAction *action, SoNode *node)
static void	writeS (SoAction *action, SoNode *node)
static void	audioRenderS (SoAction *action, SoNode *node)
static void	getPrimitiveCountS (SoAction *action, SoNode *node)
Static Public Member Functions inherited from SoFieldContainer
static void	initCopyDict (void)
static void	addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
static void	copyDone (void)
Static Public Member Functions inherited from SoBase
static void	initClass (void)
static SoType	getClassTypeId (void)
static void	addName (SoBase *const base, const char *const name)
static void	removeName (SoBase *const base, const char *const name)
static void	incrementCurrentWriteCounter (void)
static void	decrementCurrentWriteCounter (void)
static SoBase *	getNamedBase (const SbName &name, SoType type)
static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
static SbBool	read (SoInput *input, SoBase *&base, SoType expectedtype)
static void	setInstancePrefix (const SbString &c)
static void	setTraceRefs (SbBool trace)
static SbBool	getTraceRefs (void)
static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFVec2f	origin
SoSFVec2f	size
SoSFBool	flipX
SoSFBool	flipY
SoSFBool	clampSize
SoSFVec2f	pixelOrigin
SoSFVec2f	pixelSize
SoSFBool	clearDepthBuffer
SoSFBool	clearColorBuffer
SoSFColor	clearColor
Public Attributes inherited from SoNode
	INVENTOR
	VRML1
	VRML2
	INVENTOR_1
	INVENTOR_2_0
	INVENTOR_2_1
	INVENTOR_2_5
	INVENTOR_2_6
	COIN_1_0
	COIN_2_0
	EXTENSION

Protected Member Functions
virtual	~ViewportRegion ()
virtual void	notify (SoNotList *list)
Protected Member Functions inherited from SoNode
	SoNode (void)
virtual	~SoNode ()
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)
virtual	~SoFieldContainer ()
Protected Member Functions inherited from SoBase
	SoBase (void)
virtual	~SoBase ()
virtual void	destroy (void)
SbBool	hasMultipleWriteRefs (void) const
SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void	writeFooter (SoOutput *out) const
virtual const char *	getFileFormatName (void) const

Additional Inherited Members
Public Types inherited from SoNode
enum	NodeType
Protected Types inherited from SoBase
enum	BaseFlags
Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)
static void	setNextActionMethodIndex (int index)
static int	getNextActionMethodIndex (void)
static void	incNextActionMethodIndex (void)
static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)
Protected Attributes inherited from SoNode
SbUniqueId	uniqueId
Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn
Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId
static int	nextActionMethodIndex

Detailed Description

The ViewportRegion class is used to specify a sub-viewport.

Constructor & Destructor Documentation

ViewportRegion()

ViewportRegion::ViewportRegion

(

void

)

Constructor.

~ViewportRegion()

ViewportRegion::~ViewportRegion ( )

protectedvirtual

Destructor.

Member Function Documentation

callback()

void ViewportRegion::callback ( SoCallbackAction *  action )

virtual

Reimplemented from SoNode.

doAction()

void ViewportRegion::doAction ( SoAction *  action )

virtual

Generic traversal method for this node.

Reimplemented from SoNode.

getMatrix()

void ViewportRegion::getMatrix ( SoGetMatrixAction *  action )

virtual

Coin method. Updates SoViewportElement.

Reimplemented from SoNode.

GLRender()

void ViewportRegion::GLRender ( SoGLRenderAction *  action )

virtual

Coin method. Updates SoGLViewportElement.

Reimplemented from SoNode.

handleEvent()

void ViewportRegion::handleEvent ( SoHandleEventAction *  action )

virtual

Coin method. Updates SoViewportElement.

Reimplemented from SoNode.

initClass()

void ViewportRegion::initClass ( void  )

static

Required Coin method.

notify()

void ViewportRegion::notify ( SoNotList *  list )

protectedvirtual

Reimplemented from SoNode.

pick()

void ViewportRegion::pick ( SoPickAction *  action )

virtual

Coin method. Updates SoViewportElement.

Reimplemented from SoNode.

Member Data Documentation

clampSize

SoSFBool ViewportRegion::clampSize

clearColor

SoSFColor ViewportRegion::clearColor

The color used when clearing color buffer. Default is (0,0,0).

clearColorBuffer

SoSFBool ViewportRegion::clearColorBuffer

Set to TRUE to clear color buffer for the new viewport when the node is traversed.

clearDepthBuffer

SoSFBool ViewportRegion::clearDepthBuffer

Set to TRUE to clear depth buffer for the new viewport when node is traversed.

flipX

SoSFBool ViewportRegion::flipX

Invert the x coordinate. Normally x=0 is at the left, setting this to TRUE will make x=0 at the right.

flipY

SoSFBool ViewportRegion::flipY

Invert the y coordinate. Normally y=0 is at the bottom, setting this to TRUE will make y=0 at the top.

origin

SoSFVec2f ViewportRegion::origin

Origin of new viewport. (0,0) is lower left corner of current viewport. (1,1) is upper right. Default value is (0,0). The field last written into of origin and pixelOrigin will be used to set the origin when the node is traversed.

See also

pixelOrigin

pixelOrigin

SoSFVec2f ViewportRegion::pixelOrigin

Can be used to set origin directly, in pixels from lower left corner of viewport window. Default value is (0,0).

See also

origin

pixelSize

SoSFVec2f ViewportRegion::pixelSize

Can be used to set size directly, in pixels. Default value is (128,128).

See also

size

size

SoSFVec2f ViewportRegion::size

Size of new viewport. (1,1) will create a viewport with the same size as the current. Default value is (1,1). The field last written into of size and pixelSize will be used to set the size when the node is traversed.

See also

pixelSize

---

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

• C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/ViewportRegion.h
• C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/ViewportRegion.cpp