SoCameraKit(3IV)

SoCameraKit (SoCamKit) - camera nodekit class

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.22.

NAME
     SoCameraKit (SoCamKit) - camera nodekit class

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoBaseKit > SoCameraKit

SYNOPSIS
     #include <Inventor_c/nodekits/SoCameraKit.h>

     typedef SoCameraKit  SoCamKit

          Parts from class SoCameraKit:

     (SoTransform)       transform
     (SoCamera)          camera

          Parts from class SoBaseKit:

     (SoNodeKitListPart)  callbackList

          Functions from class SoCameraKit:

     SoCameraKit *             SoCamKitCreate()
     const SoNodekitCatalog *  SoCamKitGetClassNkitCat()
     SoType                    SoCamKitGetClassTypeId()

          Functions from class SoBaseKit:

     const SoNodekitCatalog *  SoCamKitGetCat(const SoCamKit *this)
     SoNode *                  SoCamKitGetPart(SoCamKit *this, const char
                                    *partName, SbBool makeIfNeeded)
     SbString                  SoCamKitGetPartString(SoCamKit *this, const
                                    SoBase *part)
     SoNodeKitPath *           SoCamKitCreatePathToPart(SoCamKit *this, const
                                    char *partName, SbBool makeIfNeeded, const
                                    SoPath *pathToExtend = NULL)
     SbBool                    SoCamKitSetPart(SoCamKit *this, const char
                                    *partName, SoNode *newPart)
     SbBool                    SoCamKitSet(SoCamKit *this, char *partName,
                                    char *parameters)
     SbBool                    SoCamKitSet2(SoCamKit *this, char
                                    *nameValuePairs)
     SbBool                    SoCamKitIsSearchingChildren()
     void                      SoCamKitSetSearchingChildren(SbBool newVal)

          Functions from class SoNode:

     void                SoCamKitSetOverride(SoCamKit *this, SbBool state)
     SbBool              SoCamKitIsOverride(const SoCamKit *this)
     SoNode *            SoCamKitCopy(const SoCamKit *this, SbBool
                              copyConnections = FALSE)

     SbBool              SoCamKitAffectsState(const SoCamKit *this)
     SoNode *            SoCamKitGetByName(const char *name)
     int                 SoCamKitGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoCamKitSetToDflts(SoCamKit *this)
     SbBool              SoCamKitHasDfltVals(const SoCamKit *this)
     SbBool              SoCamKitFldsAreEq(const SoCamKit *this, const
                              SoFieldContainer *fc)
     void                SoCamKitCopyFieldVals(SoCamKit *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     void                SoCamKitGet(SoCamKit *this, SbString
                              *fieldDataString)
     int                 SoCamKitGetFields(const SoCamKit *this, SoFieldList
                              *resultList)
     SoField *           SoCamKitGetField(const SoCamKit *this, const char
                              *fieldName)
     SbBool              SoCamKitGetFieldName(const SoCamKit *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoCamKitIsNotifyEnabled(const SoCamKit *this)
     SbBool              SoCamKitEnableNotify(SoCamKit *this, SbBool flag)

          Functions from class SoBase:

     void                SoCamKitRef(SoCamKit *this)
     void                SoCamKitUnref(const SoCamKit *this)
     void                SoCamKitUnrefNoDelete(const SoCamKit *this)
     void                SoCamKitTouch(SoCamKit *this)
     SoType              SoCamKitGetTypeId(const SoCamKit *this)
     SbBool              SoCamKitIsOfType(const SoCamKit *this, SoType type)
     void                SoCamKitSetName(SoCamKit *this, const char *name)
     SbName              SoCamKitGetName(const SoCamKit *this)


DESCRIPTION
     This nodekit class is used to create camera nodes that have a local
     transformation. SoCameraKit adds two public parts to the basic nodekit:
     transform and camera.

     The camera part is created by default as an SoPerspectiveCamera node, but
     may later be changed to any subclass of SoCamera.

     You can move the camera relative to the rest of the scene by creating and
     editing the transform part.

     SoCameraKit also adds a private part, transformGroup, which is of type
     SoTransformSeparator. The kit uses this part to contain the effect of
     transform to move only the camera, while allowing the camera to affect
     the rest of the scene.
     SoCameraKit is derived from SoBaseKit and thus also includes a
     callbackList part for adding callback nodes.

PARTS
     (SoTransform)       transform
          A transform that positions and orients the camera relative to the
          rest of the scene. Private parts keep the effect of the transform
          part localized. This part is NULL by default, but may be set to any
          subclass of SoTransform

     (SoCamera)          camera
          The camera node for this nodekit. The camera part is created by
          default as an SoPerspectiveCamera node, but may later be changed to
          any subclass of SoCamera. (e.g., SoPerspectiveCamera,
          SoOrthographicCamera).


FUNCTIONS
     SoCameraKit *             SoCamKitCreate()
          Constructor.

     const SoNodekitCatalog *  SoCamKitGetClassNkitCat()
          Returns an SoNodekitCatalog for the class SoCameraKit.

     SoType                    SoCamKitGetClassTypeId()
          Returns type identifier for this class.


CATALOG PARTS
     ______________________________________________________________
                               All parts
                                                           NULL by
      Part Name      Part Type         Default Type        Default

      callbackList   NodeKitListPart   --                    yes
      transform      Transform         --                    yes
      camera         Camera            PerspectiveCamera     no

     ______________________________________________________________
     |






                                                                   |







     ________________________________________________________________
            Extra information for list parts from above table

      Part Name      Container Type   Permissible Types

                                      Callback, EventCallback
      callbackList   Separator

     ________________________________________________________________
     |




                                                                     |






FILE FORMAT/DEFAULTS
     CameraKit {
          callbackList  NULL
          transform     NULL
          camera        PerspectiveCamera {
          }
     }

SEE ALSO
     SoAppearanceKit, SoBaseKit, SoLightKit, SoNodeKit, SoNodeKitDetail,
     SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit,
     SoSeparatorKit, SoShapeKit, SoWrapperKit