class HotpointMission@EXClassNullAway class HotpointMission
Package: dji.common.mission.hotpoint
Description:
This class represents a Hotpoint mission. In a Hotpoint mission, the aircraft will repeatedly fly circles of a constant radius around a specified point called a Hot Point. The user can control the aircraft to fly around the Hotpoint with a specific radius and altitude. During execution, the user can also use the physical remote controller to modify its radius and speed. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.
Class Members:
method setHotpointvoid setHotpoint (LocationCoordinate2D hotpoint)
Package: dji.common.mission.hotpoint
Description:
Sets the coordinate of the hotpoint.
method getHotpointLocationCoordinate2D getHotpoint ()
Package: dji.common.mission.hotpoint
Description:
Gets the coordinate of the hotpoint.
Return:
method setStartPointvoid setStartPoint (HotpointStartPoint startPoint)
Package: dji.common.mission.hotpoint
Description:
Set aircraft's initial point on the circular flight path when starting the hotpoint mission.
method getStartPointHotpointStartPoint getStartPoint ()
Package: dji.common.mission.hotpoint
Description:
Get aircraft's initial point on the circular flight path when starting the hotpoint mission.
Return:
method setHeadingvoid setHeading (HotpointHeading heading)
Package: dji.common.mission.hotpoint
Description:
Aircraft's heading while flying around the hotpoint. It can be pointed toward or away from the hotpoint, forward or backward along its flight route, or can be manually controlled by the remote controller.
method getHeadingHotpointHeading getHeading ()
Package: dji.common.mission.hotpoint
Description:
Get the aircraft's heading while flying around the hotpoint. It can be pointed toward or away from the hotpoint, forward or backward along its flight route, and can be controlled by the remote controller.
Return:
method setAltitudevoid setAltitude (double altitude)
Package: dji.common.mission.hotpoint
Description:
Sets the altitude of the hotpoint orbit with a range [5,500] meters. The altitude is relative to the ground altitude from which the aircraft took off.
double altitude A double value of altitude to set.
method getAltitudePackage: dji.common.mission.hotpoint
Description:
Gets the altitude of the hotpoint orbit with a range [5,500] meters. The altitude is relative to the ground altitude from which the aircraft took off.
Return:
double A double value of altitude.
method setRadiusvoid setRadius (double radius)
Package: dji.common.mission.hotpoint
Description:
Sets the circular flight path radius with which the aircraft will fly around the hotpoint. The value of this property should be in the range of [MIN_RADIUS MAX_RADIUS
double radius A double value of radius to set.
method getRadiusPackage: dji.common.mission.hotpoint
Description:
Gets the circular flight path radius with which the aircraft will fly around the hotpoint. The value of this property should be in the range of [MIN_RADIUS MAX_RADIUS
Return:
double A double value of radius.
method setAngularVelocityvoid setAngularVelocity (float angularVelocity)
Package: dji.common.mission.hotpoint
Description:
Sets the angular velocity in degrees/s of the aircraft as it orbits the hot point. The default value is 20 degrees/s. The maximum angular velocity allowed is relative to the orbit radius.
float angularVelocity Angular velocity in degrees/s.
method getAngularVelocityfloat getAngularVelocity ()
Package: dji.common.mission.hotpoint
Description:
Gets the angular velocity (in degrees/second) of the aircraft as it orbits the hot point. The default value is 20 degrees/s. The angular velocity is relative to the orbit radius.
Return:
float An int value of angular velocity.
method isClockwisePackage: dji.common.mission.hotpoint
Description:
true if the aircraft will move in a clockwise direction around the hotpoint.
Return:
boolean A boolean value to check if is clockwise.
method setClockwisevoid setClockwise (boolean clockwise)
Package: dji.common.mission.hotpoint
Description:
Set to true if the aircraft should move in a clockwise direction around the hotpoint.
boolean clockwise true for clockwise direction.
method HotpointMissionHotpointMission(LocationCoordinate2D hotpoint, double altitude, double radius, float angularVelocity, boolean isClockwise, HotpointStartPoint startPoint, HotpointHeading heading)
Package: dji.common.mission.hotpoint
Description:
Constructor method for the DJIHotPointMission.
LocationCoordinate2D hotpoint Location of the hotpoint. double altitude Altitude of the orbit in meters double radius Radius of the orbit in meters float angularVelocity Angular velocity of the aircraft in degrees/s boolean isClockwise true if the aircraft should move in a clockwise direction around the hotpoint.HotpointStartPoint startPoint Initial location on the orbit to start HotpointHeading heading Aircraft heading during the mission
method resetMissionWithDatavoid resetMissionWithData (HotpointMission data)
Package: dji.common.mission.hotpoint
Description:
Reset Mission with Hotpoint Mission data.
final MAX_RADIUSstatic final double MAX_RADIUS = 500
Package: dji.common.mission.hotpoint
Description:
Maximum radius, in meters, of the circular path the aircraft will fly around the point of interest. Currently 500m.
final MIN_RADIUSstatic final double MIN_RADIUS = 5
Package: dji.common.mission.hotpoint
Description:
Minimum radius, in meters, of the circular path the aircraft will fly around the point of interest.
final MAX_ALTITUDEstatic final double MAX_ALTITUDE = 500
Package: dji.common.mission.hotpoint
Description:
Maximum altitude in meters for a Hotpoint mission.
final MIN_ALTITUDEstatic final double MIN_ALTITUDE = 5
Package: dji.common.mission.hotpoint
Description:
Minimum altitude in meters for a Hotpoint mission.
enum HotpointStartPoint@EXClassNullAway enum HotpointStartPoint
Package: dji.common.mission.hotpoint
Description:
Aircraft starting point relative to the hotpoint.
Enum Members:
Start from the North. Start from the South. Start from the West. Start from the East. Start the circle surrounding the hotpoint at the nearest point on the circle to the aircraft's current location.
Class Members:
enum HotpointHeading@EXClassNullAway enum HotpointHeading
Package: dji.common.mission.hotpoint
Description:
Heading of the aircraft while orbiting the hotpoint.
Enum Members:
Heading is in the forward direction of travel along the circular path. Heading is in the backward direction of travel along the circular path. Heading is toward the hotpoint. Heading of the aircraft is looking away from the hotpoint. It is in the direction of the vector defined from the hotpoint to the aircraft. Heading is controlled by the remote controller. The heading remains the same as the heading of the aircraft when the mission started.
Class Members: