The SoFrustumCamera class defines a camera with a generic frustum.. More...

#include <Inventor/nodes/SoFrustumCamera.h>

Inheritance diagram for SoFrustumCamera:

Public Member Functions
	SoFrustumCamera (void)

virtual SoType	getTypeId (void) const

virtual SbViewVolume	getViewVolume (float useaspectratio=0.0f) const

virtual void	scaleHeight (float scalefactor)

Public Member Functions inherited from SoCamera
virtual void	audioRender (SoAudioRenderAction *action)

virtual void	callback (SoCallbackAction *action)

virtual void	doAction (SoAction *action)

float	getBalanceAdjustment (void) const

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

float	getStereoAdjustment (void) const

StereoMode	getStereoMode (void) const

SbViewportRegion	getViewportBounds (const SbViewportRegion &region) const

SbViewVolume	getViewVolume (const SbViewportRegion &vp, SbViewportRegion &resultvp, const SbMatrix &mm=SbMatrix::identity()) const

virtual void	GLRender (SoGLRenderAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

void	pointAt (const SbVec3f &targetpoint)

void	pointAt (const SbVec3f &targetpoint, const SbVec3f &upvector)

virtual void	rayPick (SoRayPickAction *action)

void	setBalanceAdjustment (float adjustment)

void	setStereoAdjustment (float adjustment)

void	setStereoMode (StereoMode mode)

void	viewAll (SoNode *const sceneroot, const SbViewportRegion &vpregion, const float slack=1.0f)

void	viewAll (SoPath *const path, const SbViewportRegion &vpregion, const float slack=1.0f)

Public Member Functions inherited from SoNode
virtual SoNode *	addToCopyDict (void) const

virtual SbBool	affectsState (void) const

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

virtual SoFieldContainer *	copyThroughConnection (void) const

virtual SoChildList *	getChildren (void) const

SbUniqueId	getNodeId (void) const

NodeType	getNodeType (void) const

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsCleanup (void)

virtual void	grabEventsSetup (void)

SbBool	isOverride (void) const

virtual void	notify (SoNotList *l)

virtual void	pick (SoPickAction *action)

virtual void	search (SoSearchAction *action)

void	setNodeType (const NodeType type)

void	setOverride (const SbBool state)

virtual void	startNotify (void)

virtual void	write (SoWriteAction *action)

virtual void	writeInstance (SoOutput *out)

Public Member Functions inherited from SoFieldContainer
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	enableNotify (const SbBool flag)

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	get (SbString &fielddata)

void	get (SbString &fielddata, SoOutput *out)

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

virtual SoField *	getField (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

virtual int	getFields (SoFieldList &l) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

SbBool	getIsBuiltIn (void) const

void *	getUserData (void) const

SbBool	hasDefaultValues (void) const

SbBool	isNotifyEnabled (void) const

SbBool	set (const char *const fielddata)

SbBool	set (const char fielddata, SoInput input)

void	setToDefaults (void)

void	setUserData (void *userdata) const

virtual SbBool	validateNewFieldValue (SoField field, void newval)

Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	assertAlive (void) const

const SoAuditorList &	getAuditors (void) const

virtual SbName	getName (void) const

int32_t	getRefCount (void) const

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type.

void	ref (void) const

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

virtual void	setName (const SbName &newname)

SbBool	shouldWrite (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static SoType	getClassTypeId (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Static Public Member Functions inherited from SoCamera
static SoType	getClassTypeId (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Static Public Member Functions inherited from SoNode
static void	audioRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static SoType	getClassTypeId (void)

static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static void	getMatrixS (SoAction action, SoNode node)

static SbUniqueId	getNextNodeId (void)

static void	getPrimitiveCountS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initClasses (void)

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 Public Member Functions inherited from SoFieldContainer
static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static void	cleanupClass (void)

static void	copyDone (void)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initCopyDict (void)

Static Public Member Functions inherited from SoBase
static void	addName (SoBase const base, const char const name)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static void	decrementCurrentWriteCounter (void)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	getTraceRefs (void)

static void	incrementCurrentWriteCounter (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static SbBool	readRoute (SoInput *input)

static void	removeName (SoBase const base, const char const name)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

Public Attributes
SoSFFloat	bottom

SoSFFloat	left

SoSFFloat	right

SoSFFloat	top

Public Attributes inherited from SoCamera
SoSFFloat	aspectRatio

SoSFFloat	farDistance

SoSFFloat	focalDistance

SoSFFloat	nearDistance

SoSFRotation	orientation

SoSFVec3f	position

SoSFEnum	viewportMapping

Protected Member Functions
virtual	~SoFrustumCamera ()

virtual const SoFieldData *	getFieldData (void) const

virtual void	viewBoundingBox (const SbBox3f &box, float aspect, float slack)

Protected Member Functions inherited from SoCamera
	SoCamera (void)

virtual	~SoCamera ()

virtual void	jitter (int numpasses, int curpass, const SbViewportRegion &vpreg, SbVec3f &jitteramount) const

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 SoNotRec	createNotRec (void)

virtual void	destroy (void)

virtual const char *	getFileFormatName (void) const

SbBool	hasMultipleWriteRefs (void) const

void	writeFooter (SoOutput *out) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

Static Protected Member Functions
static const SoFieldData **	getFieldDataPtr (void)

Static Protected Member Functions inherited from SoCamera
static const SoFieldData **	getFieldDataPtr (void)

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

static void	setNextActionMethodIndex (int index)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Additional Inherited Members
Public Types inherited from SoCamera
enum	StereoMode { MONOSCOPIC , LEFT_VIEW , RIGHT_VIEW }

enum	ViewportMapping { CROP_VIEWPORT_FILL_FRAME , CROP_VIEWPORT_LINE_FRAME , CROP_VIEWPORT_NO_FRAME , ADJUST_CAMERA , LEAVE_ALONE }

Public Types inherited from SoNode
enum	NodeType { INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 , INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 , COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 , COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 , COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000 }

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Static Protected Attributes inherited from SoNode
static int	nextActionMethodIndex = 0

static SbUniqueId	nextUniqueId = 1

Detailed Description

The SoFrustumCamera class defines a camera with a generic frustum..

The SoFrustumCamera class makes it possible to specify a frustum in the same manner as the OpenGL glFrustum() function. It has four new fields (left, right, top, bottom), and will use SoCamera::nearDistance and SoCamera::farDistance for the two last glFrustum() parameters.

This camera can be useful in applications that require full control over the view frustum, such as in CAVE or other multipipe applications.

Since: Coin 2.5

Constructor & Destructor Documentation

◆ SoFrustumCamera()

SoFrustumCamera::SoFrustumCamera ( void )

Constructor.

◆ ~SoFrustumCamera()

SoFrustumCamera::~SoFrustumCamera ( void )

protectedvirtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

SoType SoFrustumCamera::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getFieldData()

const SoFieldData * SoFrustumCamera::getFieldData ( void ) const

protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoCamera.

◆ getFieldDataPtr()

const SoFieldData ** SoFrustumCamera::getFieldDataPtr ( void )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

◆ getTypeId()

SoType SoFrustumCamera::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoCamera.

◆ getViewVolume()

SbViewVolume SoFrustumCamera::getViewVolume ( float useaspectratio = 0.0f ) const

virtual

Returns total view volume covered by the camera under the current settings.

This view volume is not adjusted to account for viewport mapping. If you want the same view volume as the one used during rendering, you should use getViewVolume(SbViewportRegion & vp, const SbMatrix & mm), or do something like this:

SbViewVolume vv;
float aspectratio = myviewport.getViewportAspectRatio();

switch (camera->viewportMapping.getValue()) {
case SoCamera::CROP_VIEWPORT_FILL_FRAME:
case SoCamera::CROP_VIEWPORT_LINE_FRAME:
case SoCamera::CROP_VIEWPORT_NO_FRAME:
  vv = camera->getViewVolume(0.0f);
  break;
case SoCamera::ADJUST_CAMERA:
  vv = camera->getViewVolume(aspectratio);
  if (aspectratio < 1.0f) vv.scale(1.0f / aspectratio);
  break;
case SoCamera::LEAVE_ALONE:
  vv = camera->getViewVolume(0.0f);
  break;
default:
  assert(0 && "unknown viewport mapping");
  break;
}

Also, for the CROPPED viewport mappings, the viewport might be changed if the viewport aspect ratio is not equal to the camera aspect ratio. See the SoCamera::getView() source-code (private method) to see how this is done.

Implements SoCamera.

◆ scaleHeight()

void SoFrustumCamera::scaleHeight ( float scalefactor )

virtual

Sets a scalefactor for the height of the camera viewport. What "viewport height" means exactly in this context depends on the camera model. See documentation in subclasses.

Implements SoCamera.

◆ viewBoundingBox()

void SoFrustumCamera::viewBoundingBox	(	const SbBox3f &	box,
		float	aspect,
		float	slack )

protectedvirtual

Convenience method for setting up the camera definition to cover the given bounding box with the given aspect ratio. Multiplies the exact dimensions with a slack factor to have some space between the rendered model and the borders of the rendering area.

If you define your own camera node class, be aware that this method should not set the orientation field of the camera, only the position, focal distance and near and far clipping planes.

Implements SoCamera.

Member Data Documentation

◆ bottom

SoSFFloat SoFrustumCamera::bottom

The bottom clipping plane position. Default value is -0.5.

◆ left

SoSFFloat SoFrustumCamera::left

The left clipping plane position. Default value is -0.5.

◆ right

SoSFFloat SoFrustumCamera::right

The right clipping plane position. Default value is 0.5

◆ top

SoSFFloat SoFrustumCamera::top

The top clipping plane position. Default value is 0.5.

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

SoFrustumCamera.h
SoFrustumCamera.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoFrustumCamera()

◆ ~SoFrustumCamera()

Member Function Documentation

◆ getClassTypeId()

◆ getFieldData()

◆ getFieldDataPtr()

◆ getTypeId()

◆ getViewVolume()

◆ scaleHeight()

◆ viewBoundingBox()

Member Data Documentation

◆ bottom

◆ left

◆ right

◆ top