DJI Mobile SDK Documentation

      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.

      Class Members:
      Coordinate
      method
      method setHotpoint
      void setHotpoint(LocationCoordinate2D hotpoint)
      Package:dji.common.mission.hotpoint
      Description:

      Sets the coordinate of the hotpoint.

      Input Parameters:
      LocationCoordinate2D hotpointA LocationCoordinate2D object of hotpoint.
      method getHotpoint
      LocationCoordinate2D getHotpoint()
      Package:dji.common.mission.hotpoint
      Description:

      Gets the coordinate of the hotpoint.

      Return:
      LocationCoordinate2DA object of LocationCoordinate2D.
      Start Point
      method
      method setStartPoint
      void setStartPoint(HotpointStartPoint startPoint)
      Package:dji.common.mission.hotpoint
      Description:

      Set aircraft's initial point on the circular flight path when starting the hotpoint mission.

      Input Parameters:
      HotpointStartPoint startPointAn enum value of HotpointStartPoint.
      method getStartPoint
      HotpointStartPoint getStartPoint()
      Package:dji.common.mission.hotpoint
      Description:

      Get aircraft's initial point on the circular flight path when starting the hotpoint mission.

      Return:
      HotpointStartPointAn enum value of HotpointStartPoint.
      Heading
      method
      method setHeading
      void 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.

      Input Parameters:
      HotpointHeading headingAircraft heading.
      method getHeading
      HotpointHeading 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:
      HotpointHeadingAircraft heading.
      Altitude
      method
      method setAltitude
      void 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.

      Input Parameters:
      double altitudeA double value of altitude to set.
      method getAltitude
      double getAltitude()
      Package: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:
      doubleA double value of altitude.
      Radius
      method
      method setRadius
      void 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] meters.

      Input Parameters:
      double radiusA double value of radius to set.
      method
      method getRadius
      double getRadius()
      Package: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] meters.

      Return:
      doubleA double value of radius.
      Angular Velocity
      method
      method setAngularVelocity
      void 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.

      Input Parameters:
      float angularVelocityAngular velocity in degrees/s.
      method getAngularVelocity
      float 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:
      floatAn int value of angular velocity.
      Direction
      method
      method isClockwise
      boolean isClockwise()
      Package:dji.common.mission.hotpoint
      Description:

      true if the aircraft will move in a clockwise direction around the hotpoint.

      Return:
      booleanA boolean value to check if is clockwise.
      method setClockwise
      void setClockwise(boolean clockwise)
      Package:dji.common.mission.hotpoint
      Description:

      Set to true if the aircraft should move in a clockwise direction around the hotpoint.

      Input Parameters:
      boolean clockwisetrue for clockwise direction.
      Constructor
      method
      method HotpointMission
      HotpointMission(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.

      Input Parameters:
      LocationCoordinate2D hotpointLocation of the hotpoint.
      double altitudeAltitude of the orbit in meters
      double radiusRadius of the orbit in meters
      float angularVelocityAngular velocity of the aircraft in degrees/s
      boolean isClockwisetrue if the aircraft should move in a clockwise direction around the hotpoint.
      HotpointStartPoint startPointInitial location on the orbit to start
      HotpointHeading headingAircraft heading during the mission
      Reset Data
      method
      method resetMissionWithData
      void resetMissionWithData(HotpointMission data)
      Package:dji.common.mission.hotpoint
      Description:

      Reset Mission with Hotpoint Mission data.

      Input Parameters:
      HotpointMission dataAn object of HotpointMission.
      final MAX_RADIUS
      static 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_RADIUS
      static 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_ALTITUDE
      static final double MAX_ALTITUDE = 500
      Package:dji.common.mission.hotpoint
      Description:

      Maximum altitude in meters for a Hotpoint mission.

      final MIN_ALTITUDE
      static 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:
      NORTHStart from the North.
      SOUTHStart from the South.
      WESTStart from the West.
      EASTStart from the East.
      NEARESTStart 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:
      ALONG_CIRCLE_LOOKING_FORWARDSHeading is in the forward direction of travel along the circular path.
      ALONG_CIRCLE_LOOKING_BACKWARDSHeading is in the backward direction of travel along the circular path.
      TOWARDS_HOT_POINTHeading is toward the hotpoint.
      AWAY_FROM_HOT_POINTHeading of the aircraft is looking away from the hotpoint. It is in the direction of the vector defined from the hotpoint to the aircraft.
      CONTROLLED_BY_REMOTE_CONTROLLERHeading is controlled by the remote controller.
      USING_INITIAL_HEADINGThe heading remains the same as the heading of the aircraft when the mission started.
      Class Members: