SoRotateSphericalDragger(3IV)NAMESoRotateSphericalDragger (SoRotSphDrag) - object you can rotate about a
spherical surface by dragging with the mouse
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit >
SoDragger > SoRotateSphericalDraggerSYNOPSIS
#include <Inventor_c/draggers/SoRotateSphericalDragger.h>
typedef SoRotateSphericalDragger
SoRotSphDrag
Fields from class SoRotateSphericalDragger:
SoSFRotation rotation
Fields from class SoDragger:
SoSFBool isActive
Fields from class SoInteractionKit:
SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling
Parts from class SoBaseKit:
(SoNodeKitListPart) callbackList
Functions from class SoRotateSphericalDragger:
SoRotateSphericalDragger * SoRotSphDragCreate()
void SoRotSphDragSetProj(SoRotSphDrag *this,
SbSphereProjector *p)
const SbSphereProjector * SoRotSphDragGetProj(const SoRotSphDrag *this)
const SoNodekitCatalog * SoRotSphDragGetClassNkitCat()
SoType SoRotSphDragGetClassTypeId()
Functions from class SoDragger:
void SoRotSphDragAddStartCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoRotSphDragRemoveStartCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoRotSphDragAddMotionCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoRotSphDragRemoveMotionCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
Page 1SoRotateSphericalDragger(3IV)
void SoRotSphDragAddFinishCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoRotSphDragRemoveFinishCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoRotSphDragAddValueChangedCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoRotSphDragRemoveValueChangedCB(SoRotSphDrag *this,
SoDraggerCB *f, void *userData = NULL)
SbBool SoRotSphDragEnableValueChangedCBs(SoRotSphDrag *this)
void SoRotSphDragSetMinGesture(SoRotSphDrag *this, int
pixels)
int SoRotSphDragGetMinGesture(const SoRotSphDrag *this)
void SoRotSphDragSetMinScale(float newMinScale)
float SoRotSphDragGetMinScale()
Functions from class SoInteractionKit:
SbBool SoRotSphDragSetPartAsPath(SoRotSphDrag *this, const
char *partName, SoPath *surrogatePath )
Functions from class SoBaseKit:
const SoNodekitCatalog * SoRotSphDragGetCat(const SoRotSphDrag *this)
SoNode * SoRotSphDragGetPart(SoRotSphDrag *this, const
char *partName, SbBool makeIfNeeded)
SbString SoRotSphDragGetPartString(SoRotSphDrag *this,
const SoBase *part)
SoNodeKitPath * SoRotSphDragCreatePathToPart(SoRotSphDrag
*this, const char *partName, SbBool
makeIfNeeded, const SoPath *pathToExtend =
NULL)
SbBool SoRotSphDragSetPart(SoRotSphDrag *this, const
char *partName, SoNode *newPart)
SbBool SoRotSphDragSet(SoRotSphDrag *this, char
*partName, char *parameters)
SbBool SoRotSphDragSet2(SoRotSphDrag *this, char
*nameValuePairs)
SbBool SoRotSphDragIsSearchingChildren()
void SoRotSphDragSetSearchingChildren(SbBool newVal)
Functions from class SoNode:
void SoRotSphDragSetOverride(SoRotSphDrag *this, SbBool
state)
SbBool SoRotSphDragIsOverride(const SoRotSphDrag *this)
SoNode * SoRotSphDragCopy(const SoRotSphDrag *this, SbBool
copyConnections = FALSE)
SbBool SoRotSphDragAffectsState(const SoRotSphDrag *this)
SoNode * SoRotSphDragGetByName(const char *name)
int SoRotSphDragGetByNameList(const char *name,
SoNodeList *list)
Page 2SoRotateSphericalDragger(3IV)
Functions from class SoFieldContainer:
void SoRotSphDragSetToDflts(SoRotSphDrag *this)
SbBool SoRotSphDragHasDfltVals(const SoRotSphDrag *this)
SbBool SoRotSphDragFldsAreEq(const SoRotSphDrag *this, const
SoFieldContainer *fc)
void SoRotSphDragCopyFieldVals(SoRotSphDrag *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
void SoRotSphDragGet(SoRotSphDrag *this, SbString
*fieldDataString)
int SoRotSphDragGetFields(const SoRotSphDrag *this,
SoFieldList *resultList)
SoField * SoRotSphDragGetField(const SoRotSphDrag *this, const
char *fieldName)
SbBool SoRotSphDragGetFieldName(const SoRotSphDrag *this,
const SoField *field, SbName *fieldName)
SbBool SoRotSphDragIsNotifyEnabled(const SoRotSphDrag *this)
SbBool SoRotSphDragEnableNotify(SoRotSphDrag *this, SbBool
flag)
Functions from class SoBase:
void SoRotSphDragRef(SoRotSphDrag *this)
void SoRotSphDragUnref(const SoRotSphDrag *this)
void SoRotSphDragUnrefNoDelete(const SoRotSphDrag *this)
void SoRotSphDragTouch(SoRotSphDrag *this)
SoType SoRotSphDragGetTypeId(const SoRotSphDrag *this)
SbBool SoRotSphDragIsOfType(const SoRotSphDrag *this, SoType
type)
void SoRotSphDragSetName(SoRotSphDrag *this, const char
*name)
SbName SoRotSphDragGetName(const SoRotSphDrag *this)
DESCRIPTIONSoRotateSphericalDragger is a simple dragger that rotates freely in all
directions. The feel of the rotation is as if you were rolling a ball.
The center of rotation is the origin of the local space, determined by
the dragger's location in the scene graph. Transformation nodes placed
before it will affect both the dragger and the direction of motion.
This node has a rotation field which always reflects its orientation in
local space. If you set the field, the dragger will rotate accordingly.
You can also connect fields of other nodes or engines from this one to
make them follow the dragger's orientation.
This dragger contains four parts, rotator, rotatorActive, feedback, and
feedbackActive.
Each of these is set by default from a resource described in the Dragger
Resources section of the online reference page for this class. You can
Page 3SoRotateSphericalDragger(3IV)
change the parts in any instance of this dragger using
SoDraggerSetPart().
You can make your program use different default resources for the parts
by copying the file
/usr/share/data/draggerDefaults/rotateSphericalDragger.iv into your own
directory, editing the file, and then setting the environment variable
SO_DRAGGER_DIR to be a path to that directory.
FIELDS
SoSFRotation rotation
Orientation of the dragger.
FUNCTIONSSoRotateSphericalDragger * SoRotSphDragCreate()
Constructor.
void SoRotSphDragSetProj(SoRotSphDrag *this,
SbSphereProjector *p)
const SbSphereProjector * SoRotSphDragGetProj(const SoRotSphDrag *this)
Set and get a different sphere projector. See the SbSphereProjector
man pages to find out how each kind affects the feel of your
dragger's motion. The default uses an SbSpherePlaneProjector.
Passing in NULL will cause the default type of projector to be used.
Any projector you pass in will be deleted by this dragger when this
dragger is deleted. Note that the center and radius of the sphere
are determined by the dragger, based on the origin of the local
space and the distance between the initial mouse click and that
origin.
const SoNodekitCatalog * SoRotSphDragGetClassNkitCat()
Returns an SoNodekitCatalog for this class
SoType SoRotSphDragGetClassTypeId()
Returns type identifier for this class.
CATALOG PARTSPage 4SoRotateSphericalDragger(3IV)
___________________________________________________________
All parts
NULL by
Part Name Part Type Default Type Default
callbackList NodeKitListPart -- yes
rotator Separator -- yes
rotatorActive Separator -- yes
feedback Separator -- yes
feedbackActive Separator -- yes
___________________________________________________________
|
|
________________________________________________________________
Extra information for list parts from above table
Part Name Container Type Permissible Types
Callback, EventCallback
callbackList Separator
________________________________________________________________
|
|
DRAGGER RESOURCES
Resource: rotateSphericalRotator
Part: rotator
Appearance: white sphere made of three intersecting circles. Each
circle is in a different plane of local space
Description: picking this initiates rotation
Resource: rotateSphericalRotatorActive
Part: rotatorActive
Appearance: yellow version of rotator
Description: displayed while in motion instead of the rotator
Resource: rotateSphericalFeedback
Part: feedback
Appearance: thin purple 3-D crosshairs at origin
Description: shows center of rotation when not moving
Resource: rotateSphericalFeedbackActive
Part: feedbackActive
Appearance: thin, slightly brighter purple 3-D crosshairs at origin
Description: shows center of rotation when moving
FILE FORMAT/DEFAULTS
RotateSphericalDragger {
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
isActive FALSE
rotation 0 0 1 0
callbackList NULL
rotator <rotateSphericalRotator resource>
Page 5SoRotateSphericalDragger(3IV)
rotatorActive <rotateSphericalRotatorActive resource>
feedback <rotateSphericalFeedback resource>
feedbackActive <rotateSphericalFeedbackActive resource>
}
SEE ALSO
SoInteractionKit, SoDragger, SoCenterballDragger,
SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger,
SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger,
SoRotateDiscDragger, SoScale1Dragger, SoScale2Dragger,
SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger,
SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger,
SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger,
SoTranslate2Dragger
Page 6
