Abstract base class for camera nodes. More...

#include <Inventor/nodes/SoCamera.h>

Inheritance diagram for SoCamera:

Public Types
enum	ViewportMapping { CROP_VIEWPORT_FILL_FRAME = 0 , CROP_VIEWPORT_LINE_FRAME = 1 , CROP_VIEWPORT_NO_FRAME = 2 , ADJUST_CAMERA = 3 , LEAVE_ALONE = 4 }
	What will happen if the camera and. More...

Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

Fields
NOTE: These fields are here so that all camera subclasses do not have to define them separately. However, all subclasses DO have to set up field data with these fields in them to make things work properly.
SoSFEnum	viewportMapping
	Defines how to map the rendered image into the current viewport, when the aspect ratio of the camera differs from that of the viewport.

SoSFVec3f	position
	The location of the camera viewpoint.

SoSFRotation	orientation
	The orientation of the camera viewpoint, defined as a rotation of the viewing direction from its default (0,0,-1) vector.

SoSFFloat	aspectRatio
	The ratio of camera viewing width to height.

SoSFFloat	nearDistance
	Distance from viewpoint to view plane.

SoSFFloat	farDistance
	Distance from viewpoint to far clipping plane.

SoSFFloat	focalDistance
	The distance from the viewpoint to the point of focus.

void	pointAt (const SbVec3f &targetPoint)
	Sets the orientation of the camera so that it points toward the given target point while keeping the "up" direction of the camera parallel to the positive y-axis.

virtual void	scaleHeight (float scaleFactor)=0
	Scales the height of the camera.

virtual SbViewVolume	getViewVolume (float useAspectRatio=0.0) const =0
	Returns a view volume structure, based on the camera's viewing parameters.

void	viewAll (SoNode *sceneRoot, const SbViewportRegion &vpRegion, float slack=1.0)
	Sets the camera up to view the scene under the given node or defined by the given path.

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

SbViewportRegion	getViewportBounds (const SbViewportRegion &region) const
	Returns the viewport region this camera would use to render into the given viewport region, accounting for cropping.

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.

virtual void	callback (SoCallbackAction *action)

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	rayPick (SoRayPickAction *action)

static void	initClass ()

	SoCamera ()
	Makes this abstract.

virtual	~SoCamera ()

virtual void	viewBoundingBox (const SbBox3f &box, float aspect, float slack)=0
	Subclasses must define this method, which changes the position and clipping planes of a camera to view the passed bounding box using the given aspect ratio, without changing the height scaling.

virtual void	jitter (int numPasses, int curPass, const SbViewportRegion &vpReg, SbVec3f &jitterAmount) const
	Returns amount to jitter camera in normalized device coordinates (after projection) for anti-aliasing during multi-pass rendering.

Additional Inherited Members
Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off.

bool	isOverride () const
	Returns the state of the override flag.

SoNode *	copy (bool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual bool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	callback (SoCallbackAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

SbNodeIdType	getNodeId () const
	Returns the unique id for a node.

virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.)

virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to `fc's` fields.

void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of `fc's` fields into this object's fields.

bool	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 Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.

bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the `fieldName` argument.

bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

bool	set (const char fieldDataString, SoInput dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.

void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.

virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.

void	unref () const

void	unrefNoDelete () const

void	touch ()
	Marks an instance as modified, simulating a change to it.

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type.

virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.

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

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.

int	getRefCount () const
	Returns current reference count.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns type identifier for the SoNode class.

static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name.

static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to `list` pointers to those nodes.

static void	initClass ()
	Initializes base node class.

static void	initClasses ()
	Initialize ALL Inventor node classes.

static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id.

static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type.

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

static void	initClass ()
	Setup type information.

static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary.

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.

static void	copyDone ()
	Cleans up the dictionary when done.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

static void	initClass ()
	Setup type information.

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary.

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase.

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.

Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...

Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor.

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.

virtual void	destroy ()
	Actually deletes an instance.

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)

virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.

Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node.

Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id.

static int	nextActionMethodIndex
	Next index into the action method table.

Detailed Description

This is the abstract base class for all camera nodes. It defines the common methods and fields that all cameras have. Cameras are used to view a scene. When a camera is encountered during rendering, it sets the projection and viewing matrices and viewport appropriately; it does not draw geometry. Cameras should be placed before any shape nodes or light nodes in a scene graph; otherwise, those shapes or lights cannot be rendered properly. Cameras are affected by the current transformation, so you can position a camera by placing a transformation node before it in the scene graph . The default position and orientation of a camera is at (0,0,1) looking along the negative z-axis.

You can also use a node kit to create a camera; see the reference page for SoCameraKit.

See Also

: SoOrthographicCamera, SoPerspectiveCamera, SoCameraKit

Definition at line 96 of file SoCamera.h.

Member Enumeration Documentation

◆ ViewportMapping

enum SoCamera::ViewportMapping

Enumerator
CROP_VIEWPORT_FILL_FRAME	viewport aspect ratios differ? The first 3 adjust the viewport to fit the camera. Draw filled frame around vp.
CROP_VIEWPORT_LINE_FRAME	Draw frame in lines.
CROP_VIEWPORT_NO_FRAME	Draw no frame.
ADJUST_CAMERA	Adjust camera to fit viewport.
LEAVE_ALONE	Do nothing. Camera image may become stretched out of proportion

Definition at line 102 of file SoCamera.h.

Constructor & Destructor Documentation

◆ SoCamera()

SoCamera::SoCamera ( )

protected

◆ ~SoCamera()

virtual SoCamera::~SoCamera ( )

protectedvirtual

Member Function Documentation

◆ callback()

virtual void SoCamera::callback ( SoCallbackAction * action )

virtual

Reimplemented from SoNode.

◆ doAction()

virtual void SoCamera::doAction ( SoAction * action )

virtual

The default implementation does nothing.

Reimplemented from SoNode.

◆ getBoundingBox()

virtual void SoCamera::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Reimplemented from SoNode.

◆ getViewportBounds()

SbViewportRegion SoCamera::getViewportBounds ( const SbViewportRegion & region ) const

◆ getViewVolume()

virtual SbViewVolume SoCamera::getViewVolume ( float useAspectRatio = 0.0 ) const

pure virtual

If the useAspectRatio argument is not 0.0 (the default), the camera uses that ratio instead of the one it has.

Implemented in SoOrthographicCamera, and SoPerspectiveCamera.

◆ GLRender()

virtual void SoCamera::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoNode.

◆ handleEvent()

virtual void SoCamera::handleEvent ( SoHandleEventAction * action )

virtual

Reimplemented from SoNode.

◆ initClass()

static void SoCamera::initClass ( )

static

◆ jitter()

virtual void SoCamera::jitter	(	int	numPasses,
		int	curPass,
		const SbViewportRegion &	vpReg,
		SbVec3f &	jitterAmount
	)		const

protectedvirtual

◆ pointAt()

void SoCamera::pointAt ( const SbVec3f & targetPoint )

If this is not possible, it uses the positive z-axis as "up."

◆ rayPick()

virtual void SoCamera::rayPick ( SoRayPickAction * action )

virtual

Reimplemented from SoNode.

◆ scaleHeight()

virtual void SoCamera::scaleHeight ( float scaleFactor )

pure virtual

Perspective cameras scale their heightAngle fields, and orthographic cameras scale their height fields.

Implemented in SoOrthographicCamera, and SoPerspectiveCamera.

◆ viewAll() [1/2]

void SoCamera::viewAll	(	SoNode *	sceneRoot,
		const SbViewportRegion &	vpRegion,
		float	slack = `1.0`
	)

The near and far clipping planes will be positioned 'slack' bounding sphere radii away from the bounding box's center. A value of 1.0 will make the clipping planes the tightest around the bounding sphere.

◆ viewAll() [2/2]

void SoCamera::viewAll	(	SoPath *	path,
		const SbViewportRegion &	vpRegion,
		float	slack = `1.0`
	)

◆ viewBoundingBox()

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

protectedpure virtual

Implemented in SoOrthographicCamera, and SoPerspectiveCamera.

Member Data Documentation

◆ aspectRatio

SoSFFloat SoCamera::aspectRatio

This value must be greater than 0.0. There are several standard camera aspect ratios defined in SoCamera.h.

Definition at line 138 of file SoCamera.h.

◆ farDistance

SoSFFloat SoCamera::farDistance

Definition at line 142 of file SoCamera.h.

◆ focalDistance

SoSFFloat SoCamera::focalDistance

This is typically ignored during rendering, but may be used by some viewers to define a point of interest.

Definition at line 147 of file SoCamera.h.

◆ nearDistance

SoSFFloat SoCamera::nearDistance

Definition at line 140 of file SoCamera.h.

◆ orientation

SoSFRotation SoCamera::orientation

Definition at line 133 of file SoCamera.h.

◆ position

SoSFVec3f SoCamera::position

Definition at line 129 of file SoCamera.h.

◆ viewportMapping

SoSFEnum SoCamera::viewportMapping

Definition at line 126 of file SoCamera.h.

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

C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoCamera.h

Public Types

Fields

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ViewportMapping

Constructor & Destructor Documentation

◆ SoCamera()

◆ ~SoCamera()

Member Function Documentation

◆ callback()

◆ doAction()

◆ getBoundingBox()

◆ getViewportBounds()

◆ getViewVolume()

◆ GLRender()

◆ handleEvent()

◆ initClass()

◆ jitter()

◆ pointAt()

◆ rayPick()

◆ scaleHeight()

◆ viewAll() [1/2]

◆ viewAll() [2/2]

◆ viewBoundingBox()

Member Data Documentation

◆ aspectRatio

◆ farDistance

◆ focalDistance

◆ nearDistance

◆ orientation

◆ position

◆ viewportMapping