| Platform SDK: DirectX |
Directions can be defined for one or more axes. As with the mouse and joystick, the x-axis increases from left to right, and the y-axis increases from far to near. For three-dimensional devices, the z-axis increases from up to down.
The direction of an effect is the direction from which it comes. An effect with a direction along the negative y-axis tends to push the stick along the positive y-axis (toward the user). It is somewhat easier to visualize the axis values of a direction if you imagine the user exerting a counteracting force on the device. If the user must push the stick toward the left to counteract an effect, the effect has a left direction; that is, it lies on the negative x-axis.
Direction can be expressed in polar, spherical, or Cartesian coordinates.
Polar coordinates are expressed as a single angle, in hundredths of a degree clockwise from whatever zero-point, or true north, has been established for the effect. Normally this is the negative y-axis; that is, away from the user. Thus an effect with a polar coordinate of 9,000 normally has a direction of east, or to the user's right, and the user must exert force to the right to counteract it.
Spherical coordinates are also in hundredths of a degree, but can contain two or more angles; for each angle, the direction is rotated in the positive direction of the next axis. For a 3-D device, the first angle would normally be rotated from the positive x-axis toward the positive y-axis (clockwise from east), and the second angle would be rotated toward the positive z-axis (down). Thus a force with a direction of (0, 0) would be to the user's right and parallel to the tabletop. A direction of 27,000 for the first angle and 4,500 for the second would be directly away from the user (270 degrees clockwise from east) and angling toward the floor (45 degrees downward from the tabletop); to counteract a force with this direction, the user would have to push forward and down.
Cartesian coordinates are similar to 3-D vectors. If you draw a straight line on graph paper with an origin of (0, 0) at the center of the page, the direction of the line can be defined by the coordinates of any intersection that it crosses, regardless of the distance from the origin. A direction of (1, –2) and a direction of (5, –10) are exactly the same.
Note The coordinates used in creating force-feedback effects define only direction, not magnitude or distance.
When an effect is created or modified, the cAxes, rgdwAxes, and rglDirection members of the DIEFFECT structure are used to specify the direction of the force.
The cAxes member specifies the number of elements in the arrays pointed to by the next two members.
The array pointed to by rgdwAxes identifies the axes. If the DIEFF_OBJECTOFFSETS flag has been set, the axes are identified by the offsets within the data format structure. These offsets are most readily identified by using the DIJOFS_* defines. (For a list of these values, see Joystick Device Constants.)
Finally, the rglDirection member specifies the direction of the force.
Note The cAxes and rgdwAxes members cannot be modified once they have been set. An effect always has the same axis list.
Regardless of whether you are using Cartesian, polar, or spherical coordinates, you must provide exactly as many elements in rglDirection as there are axes in the array pointed to by rgdwAxes.
In the polar coordinate system, north (0 degrees) lies along the vector (0, –1), where the elements of the vector correspond to the elements in the axis list pointed to by rgdwAxes. Normally those axes are x and y, so north is directly along the negative y-axis; that is, away from the user. The last element of rglDirection must be 0.
In the example in Creating an Effect, the direction of a two-dimensional force is defined in polar coordinates. The force has a south direction—it comes from the direction of the user, so the user has to pull the stick to counteract it. The direction is 180 degrees clockwise from north, and can be assigned as follows:
LONG lDirection[2] = { 18000, 0 };
For greater clarity, the assignment could also be expressed as follows:
LONG lDirection[2] = { 180 * DI_DEGREES, 0 };
For spherical coordinates, presuming that you are working with a three-axis device, the same direction is assigned as follows:
LONG lDirection[3] = { 90 * DI_DEGREES, 0, 0 }
In the DIEFFECT structure, the first angle is measured in hundredths of a degree from the (1, 0) direction, rotated in the direction of (0, 1); the second angle is measured in hundredths of a degree toward (0, 0, 1). The elements of the vector notation again correspond to elements in the array pointed to by the rgdwAxes member. Assume that the elements of this array represent the x, y, and z axes, in that order. The point of origin is at x = 1 and y = 0; that is, to the user's right. The direction of rotation is toward the positive y-axis (0, 1); that is, toward the user, or clockwise. The force in the example is 90 degrees clockwise from the right; that is, south. Because the second element of lDirection is 0, there is no rotation on the third axis.
How do you accomplish the same thing with Cartesian coordinates? Presuming that you have used the DIEFF_CARTESIAN flag in the dwFlags member, you would specify the direction as follows:
LONG lDirection[2] = { 0, 1 };
Here again, the elements of the array correspond to the axes listed in the array pointed to by rgdwAxes. The example sets the x-axis to 0 and the y-axis to 1; that is, the direction lies directly along the positive y-axis, or to the south.
The theory of effect directions can be difficult to grasp, but the practice is fairly straightforward. For code examples, see Examples of Setting Effect Direction.
DirectX for Visual Basic supports two-axis effects on the x-axis and y-axis.
The direction of an effect is the direction from which it comes. An effect with a direction along the negative y-axis tends to push the stick along the positive y-axis (toward the user). It is somewhat easier to visualize the axis values of a direction if you imagine the user exerting a counteracting force on the device. If the user must push the stick toward the left in order to counteract an effect, the effect has a left direction; that is, it lies on the negative x-axis.
Direction can be expressed in polar or Cartesian coordinates. By default, polar coordinates are used, and the direction is specified in the x member of the DIEFFECT type, with y always 0. To use Cartesian coordinates, you must specify DIEFF_CARTESIAN in the lFlags member and supply values in both x and y.
Polar coordinates are expressed as a single angle, in hundredths of a degree clockwise from whatever zero-point, or true north, has been established for the effect. Normally, this is the negative y-axis; that is, away from the user. Thus an effect with a polar coordinate of 9,000 normally has a direction of east, or to the user's right, and the user must exert force to the right to counteract it.
Cartesian coordinates are similar to 3-D vectors and are most useful for matching a force to the user's orientation in a 3-D environment. If you draw a straight line on graph paper with an origin of (0, 0) at the center of the page, the direction of the line can be defined by the coordinates of any intersection that it crosses, regardless of the distance from the origin. A direction of (1, –2) and a direction of (5, –10) are exactly the same.
Note Cartesian coordinates used in creating force-feedback effects define only direction, not magnitude or distance.
The following code example reverses the direction of a force represented by the DirectInputEffect object dieff, which was created using the global DIEFFECT type effectinfo:
effectinfo.lFlags = DIEFF_CARTESIAN effectinfo.X = effectinfo.X * -1 effectinfo.Y = effectinfo.Y * -1 Call dieff.SetParameters(effectinfo, DIEP_DIRECTION)
DirectX for Visual Basic does not support setting direction for conditions.