Version
menu_open

AkPropagationPathInfo Struct Reference

Structure for retrieving information about the sound propagation paths that have been calculated via the rooms and portals API. Useful for debug draw applications. More...

List of all members.

Public Attributes

AkVector  nodePoint [kMaxNodes]
  Nodes in the path; they repreent vertices within the bounds of a portal's opening.
AkPortalID  portals [kMaxNodes]
  ID of the portal's that the path passes through. portal[0] is the portal closest to the listener; portal[numNodes-1] is the portal closest to the emitter.
AkRoomID  rooms [kMaxNodes+1]
  ID's of the rooms that the path passes through. There is always one more room than portal. room[0] is the listener's room; the emitters room is room[numNodes].
AkUInt32  numNodes
  Represents the number of valid nodes in nodePoint[] and the number of valid portals in portals[]. The number of rooms in rooms[] is numNodes+1. There is always one more room than portal.
AkReal32  length
  The sum of all straight line path segments, including the segment from the listener to nodePoint[0], between each subsequent nodePoint, and from nodePoint[numNodes-1] to the emitter.
AkReal32  gain
  The cumulative gain (linear) of all portals traversed.
AkReal32  dryDiffractionAngle
  The dry diffraction angle is measured in radians, and calculated from the maximum deviation from a straight line, of all angles at each nodePoint. Can be thought of as how.
AkReal32  wetDiffractionAngle

Static Public Attributes

static const AkUInt32  kMaxNodes = AK_MAX_SOUND_PROPAGATION_DEPTH
  Defines the maximum number of nodes that a user can retrieve information about. Longer paths will be truncated.

Detailed Description

Structure for retrieving information about the sound propagation paths that have been calculated via the rooms and portals API. Useful for debug draw applications.

Definition at line 228 of file AkSpatialAudio.h.

The documentation for this struct was generated from the following file:

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise