summaryrefslogtreecommitdiff
path: root/game/shared/rope_helpers.h
diff options
context:
space:
mode:
Diffstat (limited to 'game/shared/rope_helpers.h')
-rw-r--r--game/shared/rope_helpers.h42
1 files changed, 42 insertions, 0 deletions
diff --git a/game/shared/rope_helpers.h b/game/shared/rope_helpers.h
new file mode 100644
index 0000000..7a5ad78
--- /dev/null
+++ b/game/shared/rope_helpers.h
@@ -0,0 +1,42 @@
+//========= Copyright Valve Corporation, All rights reserved. ============//
+//
+// Purpose:
+//
+// $NoKeywords: $
+//=============================================================================//
+
+#ifndef ROPE_HELPERS_H
+#define ROPE_HELPERS_H
+#ifdef _WIN32
+#pragma once
+#endif
+
+
+#include "mathlib/vector.h"
+
+
+//
+// This function can help you choose starting conditions for your rope. It is fairly
+// expensive (slightly less than 0.5ms for a 10-node rope), but it's within reason for the
+// frequency we create ropes at.
+//
+// Input:
+// - rope endpoints
+// - the number of nodes the client will be simulating (CRopeKeyframe::m_nSegments)
+// - how low you want the rope to hang (below the lowest of the two endpoints)
+//
+// Output:
+// - pOutputLength = length of the rope
+// - pOutputSlack = slack you should set to produce the desired hang
+//
+void CalcRopeStartingConditions(
+ const Vector &vStartPos,
+ const Vector &vEndPos,
+ int const nNodes,
+ float const desiredHang,
+ float *pOutputLength,
+ float *pOutputSlack
+ );
+
+
+#endif // ROPE_HELPERS_H