https://sourceforge.net/p/hpg-projects2/wiki/Path/Recent changes to PathenSun, 07 Apr 2024 02:45:15 -0000https://sourceforge.net/p/hpg-projects2/wiki/Path/<div class="markdown_content"><p>A <strong>path</strong> is a resource in ENIGMA which allows instances to be moved<br/> along a straight or a curved line. Paths can be made in LGM path editor<br/> and stored in the executable itself or be created at runtime.</p> <h2 id="uses">Uses</h2> <p>Paths are very useful for smooth movement and animations. They are also<br/> used in <a class="" href="../motion_planning" title="wikilink">motion planning</a>. Instances can be<br/> assigned to paths and it will move along it with the given speed and<br/> direction.</p> <h2 id="functions">Functions</h2> <p><strong>Creating and modifying paths:</strong></p> <ul> <li> <p>- Adds an empty path and returns its id which is then used in other<br/> functions.</p> </li> <li> <p>- Destroys the path with the given path id and frees the memory<br/> associated with it.</p> </li> <li> <p>- Duplicates the path with the given path id and returns the id of<br/> the copy.</p> </li> <li> <p>- Copies the path from path source (srcid) to path id.</p> </li> <li> <p>- The same as path_copy and is used just for compatibility.</p> </li> <li> <p>- Appends the path with given path id to path ind.</p> </li> <li> <p>- Adds a point to the path with the given path id, at position<br/> (x,y) and with the given speed factor. Remember that a factor of 100<br/> corresponds to the actual speed. Lower values mean slowing down and<br/> higher mean speeding up.</p> </li> <li> <p>- Inserts a point in the path with the given path id before point<br/> n, at position (x,y) and with the given speed factor.</p> </li> <li> <p>- Changes the point n in the path with the given path id to<br/> position (x,y) and the given speed factor.</p> </li> <li> <p>- Deletes the point n in the path with the given path id.</p> </li> <li> <p>- Clears all the points in the path, turning it into an empty path.</p> </li> <li> <p>- Reverses the path.</p> </li> <li> <p>- Mirrors the path horizontally (with respect to its center).</p> </li> <li> <p>- Flips the path vertically (with respect to its center).</p> </li> <li> <p>- Rotates the path counter clockwise over angle degrees (around its<br/> center).</p> </li> <li> <p>- Scales the path with the given factors (from its center).</p> </li> <li> <p>- Shifts the path over the given amount.</p> </li> <li> <p>- Sets the type of the path with the given path id (0=straight,<br/> 1=smooth).</p> </li> <li> <p>- Sets whether the path must be closed (true) or open (false).</p> </li> <li> <p>- Sets the precision with which the smooth path is calculated<br/> (should lie between 1 and 8).</p> </li> </ul> <p><strong>Getting path information:</strong></p> <ul> <li> <p>- Returns whether a path with the given path id exists.</p> </li> <li> <p>- Returns the length of the path with the given path id.</p> </li> <li> <p>- Returns the type the path with the given path id (0=straight,<br/> 1=smooth).</p> </li> <li> <p>- Returns whether the path is closed (true) or not (false).</p> </li> <li> <p>- Returns the precision used for creating smoothed paths.</p> </li> <li> <p>- Returns the x position of the paths center (the point around<br/> which path is scaled, rotated, mirrored and flipped).</p> </li> <li> <p>- Returns the y position of the paths center (the point around<br/> which path is scaled, rotated, mirrored and flipped).</p> </li> <li> <p>- Returns the number of defining points for the path.</p> </li> <li> <p>- Returns the x-coordinate of the n'th defining point for the path.<br/> 0 is the first point.</p> </li> <li> <p>- Returns the y-coordinate of the n'th defining point for the path.<br/> 0 is the first point.</p> </li> <li> <p>- Returns the speed factor for the n'th defining point for the<br/> path. 0 is the first point.</p> </li> <li> <p>- Returns the length for the n'th defining point for the path. 0 is<br/> the first point. This is mostly for debugging purposes. The returned<br/> value is in pixels.</p> </li> <li> <p>- Returns the x-coordinate at position pos for the path. pos must<br/> lie between 0 and 1.</p> </li> <li> <p>- Returns the y-coordinate at position pos for the path. pos must<br/> lie between 0 and 1.</p> </li> <li> <p>- Returns the speed factor at position pos for the path. pos must<br/> lie between 0 and 1.</p> </li> <li> <p>- Returns the path direction at position pos for the path. pos must<br/> lie between 0 and 1. It is always pointing from smaller pos to<br/> larger. So if the desired direction is reversed, then the 180 must<br/> be subtracted from the returned value.</p> </li> </ul> <p><strong>Other:</strong></p> <ul> <li>- Draws the indicated path in the room with its start at position<br/> (x,y). If absolute is true the path is drawn at the position where<br/> it was defined and the values of x and y are ignored. The function<br/> is mostly used for debugging, but can also be used for some nice<br/> effects (or showing where the instance is moving in an RTS for<br/> example). It uses current drawing color and alpha. Line pattern can<br/> be added by using<br/> <a class="" href="../Drawing_shapes#draw_set_line_pattern" title="wikilink">draw_set_line_pattern</a>.</li> </ul></div>Hugh GreeneSun, 07 Apr 2024 02:45:15 -0000https://sourceforge.netec66bac07e15f601c37beb1166f77e10e66e7058