Open Inventor Reference
|
Orthographic camera node. More...
#include <Inventor/nodes/SoOrthographicCamera.h>
Fields | |
SoSFFloat | height |
Height of the viewing volume. | |
SoOrthographicCamera () | |
Creates an orthographic camera node with default settings. | |
virtual void | scaleHeight (float scaleFactor) |
Scales the height of the camera, in this case, the 'height' field. | |
virtual SbViewVolume | getViewVolume (float useAspectRatio=0.0) const |
Fills in a view volume structure, based on the camera. | |
static void | initClass () |
virtual void | viewBoundingBox (const SbBox3f &box, float aspect, float slack) |
Positions camera to view passed bounding box with given aspect ratio and current height. | |
virtual | ~SoOrthographicCamera () |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
enum | Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE } |
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. | |
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 ®ion) 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) |
![]() | |
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 | getMatrix (SoGetMatrixAction *action) |
virtual void | pick (SoPickAction *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. | |
![]() | |
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 | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
Adds a reference to the instance when 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. | |
void | addManagedSensor (SoSensor *sensor) |
Adds a sensor which is managed by the field container. | |
![]() | |
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. | |
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. | |
bool | shouldWrite () |
Returns TRUE if the instance should be written, based on the write-reference info already accumulated. | |
static void | initClass () |
![]() | |
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 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 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. | |
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. | |
![]() | |
static bool | traceRefs |
Turns on/off reference count tracing (for debugging) | |
![]() | |
enum | BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 } |
This set of enums is used when reading and writing the base. More... | |
SoCamera () | |
Makes this abstract. | |
virtual | ~SoCamera () |
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. | |
![]() | |
SoNode () | |
Constructor, destructor. | |
virtual | ~SoNode () |
![]() | |
SoFieldContainer () | |
~SoFieldContainer () | |
virtual bool | readInstance (SoInput *in, unsigned short flags) |
Reads stuff into instance. Returns FALSE on error. | |
![]() | |
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) | |
![]() | |
static const SoFieldData ** | getFieldDataPtr () |
This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. | |
![]() | |
static uint32_t | getCurrentWriteCounter () |
Returns current write counter. | |
![]() | |
SbNodeIdType | uniqueId |
Unique id for this node. | |
![]() | |
bool | isBuiltIn |
Is the subclass a built-in Inventor subclass or an extender subclass? | |
![]() | |
static SbNodeIdType | nextUniqueId |
Next available unique id. | |
static int | nextActionMethodIndex |
Next index into the action method table. | |
An orthographic camera defines a parallel projection from a viewpoint. This camera does not diminish objects with distance, as an SoPerspectiveCamera does. The viewing volume for an orthographic camera is a rectangular parallelepiped (a box).
By default, the camera is located at (0,0,1) and looks along the negative z-axis; the position and orientation fields can be used to change these values. The height field defines the total height of the viewing volume; this and the aspectRatio field determine its width.
Definition at line 104 of file SoOrthographicCamera.h.
SoOrthographicCamera::SoOrthographicCamera | ( | ) |
|
protectedvirtual |
|
virtual |
If the useAspectRatio field is not 0.0 (the default), the camera uses that ratio instead of the one it has.
Implements SoCamera.
References SoINTERNAL.
|
static |
|
virtual |
Implements SoCamera.
|
protectedvirtual |
Implements SoCamera.
SoSFFloat SoOrthographicCamera::height |
Definition at line 113 of file SoOrthographicCamera.h.