Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SoRotateDiscDragger(3IV)()			    SoRotateDiscDragger(3IV)()

NAME
       SoRotateDiscDragger  --	object	you can	rotate like a knob by dragging
       With the	mouse

INHERITS FROM
       SoBase >	SoFieldContainer > SoNode > SoBaseKit >	SoInteractionKit > So-
       Dragger > SoRotateDiscDragger

SYNOPSIS
       #include	<Inventor/draggers/SoRotateDiscDragger.h>

	  Fields from class SoRotateDiscDragger:

     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

	  Methods from class SoRotateDiscDragger:

			 SoRotateDiscDragger()
     static const SoNodekitCatalog *
			 getClassNodekitCatalog() const
     static SoType	 getClassTypeId()

	  Methods from class SoDragger:

     void		 addStartCallback(SoDraggerCB  *f,  void  *userData  =
			      NULL)
     void		 removeStartCallback(SoDraggerCB *f, void *userData  =
			      NULL)
     void		 addMotionCallback(SoDraggerCB	*f,  void  *userData =
			      NULL)
     void		 removeMotionCallback(SoDraggerCB *f, void *userData =
			      NULL)
     void		 addFinishCallback(SoDraggerCB	*f,  void  *userData =
			      NULL)
     void		 removeFinishCallback(SoDraggerCB *f, void *userData =
			      NULL)
     void		 addValueChangedCallback(SoDraggerCB  *f,  void	*user-
			      Data = NULL)
     void		 removeValueChangedCallback(SoDraggerCB	   *f,	  void
			      *userData	= NULL)
     SbBool		 enableValueChangedCallbacks()
     void		 setMinGesture(int pixels)
     int		 getMinGesture() const
     static void	 setMinScale(float newMinScale)
     static float	 getMinScale()

	  Methods from class SoInteractionKit:

     virtual  SbBool	  setPartAsPath(const SbName &partName,	SoPath *surro-
			      gatePath )

	  Methods from class SoBaseKit:

     virtual const SoNodekitCatalog *
			      getNodekitCatalog() const
     virtual   SoNode	*	  getPart(const	  SbName   &partName,	SbBool
				   makeIfNeeded)
     SbString		      getPartString(const SoBase *part)
     virtual  SoNodeKitPath *  createPathToPart(const SbName &partName,	SbBool
				   makeIfNeeded, const SoPath *pathToExtend  =
				   NULL)
     virtual SbBool	      setPart(const SbName &partName, SoNode *newPart)
     SbBool		      set(char *partName, char *parameters)
     SbBool		      set(char *nameValuePairs)
     static SbBool	      isSearchingChildren()
     static void	      setSearchingChildren(SbBool newVal)

	  Methods from class SoNode:

     void		 setOverride(SbBool state)
     SbBool		 isOverride() const
     SoNode *		 copy(SbBool copyConnections = FALSE) const
     virtual SbBool	 affectsState()	const
     static SoNode *	 getByName(const SbName	&name)
     static int		 getByName(const SbName	&name, SoNodeList &list)

	  Methods from class SoFieldContainer:

     void		 setToDefaults()
     SbBool		 hasDefaultValues() const
     SbBool		 fieldsAreEqual(const SoFieldContainer *fc) const
     void		 copyFieldValues(const	SoFieldContainer  *fc,	SbBool
			      copyConnections =	FALSE)
     void		 get(SbString &fieldDataString)
     virtual int	 getFields(SoFieldList &resultList) const
     virtual SoField *	 getField(const	SbName &fieldName) const
     SbBool		 getFieldName(const SoField *field, SbName &fieldName)
			      const
     SbBool		 isNotifyEnabled() const
     SbBool		 enableNotify(SbBool flag)

	  Methods from class SoBase:

     void		 ref()
     void		 unref() const
     void		 unrefNoDelete() const
     void		 touch()
     virtual SoType	 getTypeId() const
     SbBool		 isOfType(SoType type) const
     virtual void	 setName(const SbName &name)
     virtual SbName	 getName() const

	  Macros from class SoBaseKit:

     SO_GET_PART(kit, partName,	partClass)
     SO_CHECK_PART(kit,	partName, partClass)

DESCRIPTION
       SoRotateDiscDragger  is	a simple dragger that rotates about the	z axis
       of its local space. The feel of the rotation is as if you were spinning
       a record	on a turntable or rotating the volume knob of a	radio. The lo-
       cal space is determined by its location in the scene graph. Transforma-
       tion nodes placed before	it will	affect both the	dragger	and the	direc-
       tion 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 rotation.

       This dragger contains four parts, rotator, rotatorActive, feedback, and
       feedbackActive.

       Each of these is	set by default from a resource described in the	 Drag-
       ger  Resources section of the online reference page for this class. You
       can change the parts in any instance of this dragger using setPart().

       You can make your program use different default resources for the parts
       by  copying  the	 file  /usr/share/data/draggerDefaults/rotateDiscDrag-
       ger.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.

METHODS
			 SoRotateDiscDragger()
	  Constructor.

     static const SoNodekitCatalog *
			 getClassNodekitCatalog() const
	  Returns an SoNodekitCatalog for this class

     static SoType	 getClassTypeId()
	  Returns type identifier for this class.

CATALOG	PARTS
       +----------------------------------------------------------+
       |			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	       |
       |							       |
       |callbackList   Separator	Callback, EventCallback	       |
       |							       |
       +---------------------------------------------------------------+
DRAGGER	RESOURCES
       .in 0n+.5i
     Resource:	       rotateDiscRotator
       .in 0n+.5i
     Part:	       rotator
     Appearance:       white  cylinder	(with  axis along z-direction) made of
     lines
     Description:      picking this initiates rotation

			 .in 0n+.5i
     Resource:	       rotateDiscRotatorActive
			 .in 0n+.5i
     Part:	       rotatorActive
     Appearance:       yellow version of rotator, with added yellow cube
     Description:      displayed while in motion instead of the	rotator

			 .in 0n+.5i
     Resource:	       rotateDiscFeedback
			 .in 0n+.5i
     Part:	       feedback
     Appearance:       thin purple line	along local z-axis
     Description:      shows center of rotation	when not moving

			 .in 0n+.5i
     Resource:	       rotateDiscFeedbackActive
			 .in 0n+.5i
     Part:	       feedbackActive
     Appearance:       thin, slightly brighter purple line along local z-axis
     Description:      shows center of rotation	when moving

FILE FORMAT/DEFAULTS
       RotateDiscDragger {
	  renderCaching	      AUTO
	  boundingBoxCaching  AUTO
	  renderCulling	      AUTO
	  pickCulling	      AUTO
	  isActive	      FALSE
	  rotation	      0	0 1  0
	  callbackList	      NULL
	  rotator	      <rotateDiscRotator resource>
	  rotatorActive	      <rotateDiscRotatorActive resource>
	  feedback	      <rotateDiscFeedback resource>
	  feedbackActive      <rotateDiscFeedbackActive	resource>
     }

SEE ALSO
       SoInteractionKit, SoDragger,  SoCenterballDragger,  SoDirectionalLight-
       Dragger,	 SoDragPointDragger,  SoHandleBoxDragger,  SoJackDragger,  So-
       PointLightDragger,  SoRotateCylindricalDragger,	SoRotateSphericalDrag-
       ger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScale-
       UniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger,
       SoTrackballDragger,  SoTransformBoxDragger,  SoTransformerDragger,  So-
       Translate1Dragger, SoTranslate2Dragger

						    SoRotateDiscDragger(3IV)()

NAME | INHERITS FROM | SYNOPSIS | DESCRIPTION | FIELDS | METHODS | CATALOG PARTS | DRAGGER RESOURCES | FILE FORMAT/DEFAULTS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SoRotateDiscDragger&sektion=3iv&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help