SoVRMLKeySensor Class

Note: This API is now obsolete.

Maps pointing device motion onto a plane. <font color="#FF0000">Action not implemented for this node.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.VRMLnodesSoVRMLNode
              OIV.Inventor.VRMLnodesSoVRMLKeySensor

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoVRMLKeySensor : SoVRMLNode

<ObsoleteAttribute("See documentation for more details")>
<EditorBrowsableAttribute(EditorBrowsableState.Never)>
Public Class SoVRMLKeySensor
	Inherits SoVRMLNode

[ObsoleteAttribute(L"See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public ref class SoVRMLKeySensor : public SoVRMLNode

[<ObsoleteAttribute("See documentation for more details")>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
type SoVRMLKeySensor =  
    class
        inherit SoVRMLNode
    end

The SoVRMLKeySensor type exposes the following members.

Constructors

	Name	Description
	SoVRMLKeySensor	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Overrides SoNodeAffectsState.)
	Callback	(Inherited from SoNode.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoNode.)
	EnableEvents	Enables/disables events for all SoVRMLKeySensor objects.
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Inherited from SoNode.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	(Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	(Inherited from SoVRMLNode.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoNode.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. (Inherited from SoNode.)
	IsEventsEnabled	Queries if events are enabled for all objects of this class.
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoNode.)
	Search	(Inherited from SoNode.)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	actionKeyPress	Output event.
	actionKeyRelease	Output event.
	altKey	Output event.
	controlKey	Output event.
	enabled	Enables (true) or disables (false) the sensor.
	isActive	Output event.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	keyPress	Output event.
	keyRelease	Output event.
	metadata	Specifies the metadata node. (Inherited from SoVRMLNode.)
	shiftKey	Output event.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

</font>

See the X3D Specification, below.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML X3D SPECIFICATION

This section describes the expected behavior of the node in a conforming X3D browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the X3D specification that are not present in this help file. The complete X3D spec is available at http://www.web3d.org.

The SoVRMLKeySensor node generates events when the user presses keys on the keyboard. A SoVRMLKeySensor node can be enabled or disabled by sending it an enabled event with true or false. If the SoVRMLKeySensor node is disabled, it does not track keyboard input or send events.

keyPress and keyRelease events are generated as keys which produce characters are pressed or released on the keyboard. The values of these events is a string of length 1 containing the single UTF-8 character associated with the key pressed.

actionKeyPress and actionKeyRelease events are generated as 'action' keys are pressed and released on the keyboard.

Action Key Values
HOME PGDN LEFT END UP RIGHT PGUP DOWN F1-F12 13 16 19 14 17 20 15 18 1-12

shiftKey_depressed, controlKey_depressed, and altKey_depressed events are generated as the shift, control, and alt keys on the keyboard are pressed and released. Their value is true when the key is pressed and false when the key is released.

When a key is pressed, the SoVRMLKeySensor sends an isActive event with the value true. Once the key is released, the SoVRMLKeySensor sends an isActive event with the value false.

The SoVRMLKeySensor is not affected by its position in the transformation hierarchy.

FILE FORMAT/DEFAULT

VRMLKeySensor {
enabled true
metadata NULL
}

EVENTS

eventIn

SoSFBool set_enabled
SoSFNode set_metadata

eventOut

SoSFBool enabled_changed
SoSFInt32 actionKeyPress
SoSFInt32 actionKeyRelease
SoSFBool altKey
SoSFBool controlKey
SoSFBool shiftKey
SoSFBool isActive
SoSFString keyPress
SoSFString keyRelease
SoSFNode metadata_changed
Obsoletesince Open Inventor 9500 The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Reference

OIV.Inventor.VRMLnodes Namespace

SoSFBool	enabled_changed
SoSFInt32	actionKeyPress
SoSFInt32	actionKeyRelease
SoSFBool	altKey
SoSFBool	controlKey
SoSFBool	shiftKey
SoSFBool	isActive
SoSFString	keyPress
SoSFString	keyRelease
SoSFNode	metadata_changed