Class NavigationAgentProperties

The NavigationAgentProperties struct contains values used to specify how a NavigationAgent is represented.

Hierarchy

  • FrameworkObject
    • NavigationAgentProperties

Constructors

Accessors

  • get applyPosition(): boolean
  • Determines if the agent position is applied to the owning scene object.

    Returns boolean

  • set applyPosition(value): void
  • Parameters

    • value: boolean

    Returns void

  • get applyRotation(): boolean
  • Determines if the agent rotation is applied to the owning scene object.

    Returns boolean

  • set applyRotation(value): void
  • Parameters

    • value: boolean

    Returns void

  • get height(): number
  • The height of the agent in world units (m). The agent will not be able to walk through areas with a lower ceiling.

    The average male height is 1.75m.

    Returns number

  • set height(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumAcceleration(): number
  • The maximum acceleration.

    Returns number

  • set maximumAcceleration(value): void
  • Parameters

    • value: number

    Returns void

  • get ownerHeightOffset(): number
  • The offset to apply to the Y axis apply the agent position to the owning scene object. This helps to ensure correct position of the SceneObject when it is not anchored to the ground.

    Returns number

  • set ownerHeightOffset(value): void
  • Parameters

    • value: number

    Returns void

  • get pathQuality(): EnumValue<FeatureQuality3, number>
  • Determines the quality of the path the agent takes. Higher quality predict the path better, where the agent will attempt to shortcut if a direct path for visibile nodes can be taken. A higher path quality allows the agent to look further into distance at increased processing time. This setting also affects how a path is corrected if an agent was pushed away from its path due to factors such as agent separation or obstacles in the agent's path.

    Returns EnumValue<FeatureQuality3, number>

  • set pathQuality(value): void
  • Parameters

    Returns void

  • get radius(): number
  • The radius of the agent in world units (m). The agent will not be able to walk through passages that are narrower than the the diameter of the agent.

    The average male shoulder-to-shoulder distance is about 0.5m which corresponds to a raidus of 0.25u.

    Returns number

  • set radius(value): void
  • Parameters

    • value: number

    Returns void

  • get rotationAcceleration(): number
  • Controls how fast the agent responds to changes in the look direction.

    Returns number

    This value is used even if applyRotation is disabled for cases when the rotation is manually applied to the scene object.

  • set rotationAcceleration(value): void
  • Parameters

    • value: number

    Returns void

  • get rotationSpeed(): rsx.Degree
  • The maximum change of rotation per second in degrees.

    Returns rsx.Degree

  • set rotationSpeed(value): void
  • Parameters

    Returns void

  • get separationWeight(): number
  • Determines how far close agents stay apart from each other. Requires the AgentSeparation behavior flag to be set.

    Returns number

  • set separationWeight(value): void
  • Parameters

    • value: number

    Returns void

  • get speed(): number
  • The maximum speed in meters per second.

    Returns number

  • set speed(value): void
  • Parameters

    • value: number

    Returns void

  • get targetAreaSize(): number
  • The maximum distance to the move goal at which the agent marks his move goal as completed and signals events.

    Returns number

  • set targetAreaSize(value): void
  • Parameters

    • value: number

    Returns void