OpenClonk
C4MapScriptAlgoLines Class Reference

#include <C4MapScript.h>

Inheritance diagram for C4MapScriptAlgoLines:
[legend]
Collaboration diagram for C4MapScriptAlgoLines:
[legend]

Public Member Functions

 C4MapScriptAlgoLines (const C4PropList *props)
 
bool operator() (int32_t x, int32_t y, uint8_t &fg, uint8_t &bg) const override
 

Protected Member Functions

bool GetXYProps (const C4PropList *props, C4PropertyName k, int32_t *out_xy, bool zero_defaults)
 

Detailed Description

Definition at line 152 of file C4MapScript.h.

Constructor & Destructor Documentation

◆ C4MapScriptAlgoLines()

C4MapScriptAlgoLines::C4MapScriptAlgoLines ( const C4PropList props)

Definition at line 193 of file C4MapScriptAlgo.cpp.

194 {
195  // Get MAPALGO_Lines properties
196  lx = props->GetPropertyInt(P_X);
197  ly = props->GetPropertyInt(P_Y);
198  if (!lx && !ly) throw C4AulExecError(R"(C4MapScriptAlgoLines: Invalid direction vector. Either "X" or "Y" must be nonzero!)");
199  ox = props->GetPropertyInt(P_OffX);
200  oy = props->GetPropertyInt(P_OffY);
201  // use sync-safe distance function to calculate line width
202  int32_t l = Distance(0,0,lx,ly);
203  // default distance: double line width, so lines and gaps have same width
204  distance = props->GetPropertyInt(P_Distance);
205  if (!distance) distance = l+l; // 1+1=2
206  // cache for calculation
207  ll = int64_t(lx)*lx+int64_t(ly)*ly;
208  dl = int64_t(distance) * l;
209 }
@ P_Y
@ P_OffX
@ P_Distance
@ P_OffY
@ P_X
int32_t Distance(int32_t iX1, int32_t iY1, int32_t iX2, int32_t iY2)
Definition: Standard.cpp:25
int32_t GetPropertyInt(C4PropertyName k, int32_t default_val=0) const
Definition: C4PropList.cpp:855

References Distance(), C4PropList::GetPropertyInt(), P_Distance, P_OffX, P_OffY, P_X, and P_Y.

Here is the call graph for this function:

Member Function Documentation

◆ GetXYProps()

bool C4MapScriptAlgo::GetXYProps ( const C4PropList props,
C4PropertyName  k,
int32_t *  out_xy,
bool  zero_defaults 
)
protectedinherited

Definition at line 26 of file C4MapScriptAlgo.cpp.

27 {
28  // Evaluate property named "k" in proplist props to store two numbers in out_xy:
29  // If props->k is a single integer, fill both numbers in out_xy with it
30  // If props->k is an array, check that it contains two numbers and store them in out_xy
31  if (!props->HasProperty(&Strings.P[k]))
32  {
33  if (zero_defaults) out_xy[0] = out_xy[1] = 0;
34  return false;
35  }
36  C4Value val; C4ValueArray *arr;
37  props->GetProperty(k, &val);
38  if ((arr = val.getArray()))
39  {
40  if (arr->GetSize() != 2)
41  throw C4AulExecError(FormatString(R"(C4MapScriptAlgo: Expected either integer or array with two integer elements in property "%s".)", Strings.P[k].GetCStr()).getData());
42  out_xy[0] = arr->GetItem(0).getInt();
43  out_xy[1] = arr->GetItem(1).getInt();
44  }
45  else
46  {
47  out_xy[0] = out_xy[1] = val.getInt();
48  }
49  return true;
50 }
C4StringTable Strings
Definition: C4Globals.cpp:42
StdStrBuf FormatString(const char *szFmt,...)
Definition: StdBuf.cpp:270
bool HasProperty(C4String *k) const
Definition: C4PropList.h:122
bool GetProperty(C4PropertyName k, C4Value *pResult) const
Definition: C4PropList.h:105
const char * GetCStr() const
Definition: C4StringTable.h:49
C4String P[P_LAST]
const C4Value & GetItem(int32_t iElem) const
Definition: C4ValueArray.h:38
int32_t GetSize() const
Definition: C4ValueArray.h:36
C4ValueArray * getArray() const
Definition: C4Value.h:118
int32_t getInt() const
Definition: C4Value.h:112
const char * getData() const
Definition: StdBuf.h:442

References FormatString(), C4Value::getArray(), C4String::GetCStr(), StdStrBuf::getData(), C4Value::getInt(), C4ValueArray::GetItem(), C4PropList::GetProperty(), C4ValueArray::GetSize(), C4PropList::HasProperty(), C4StringTable::P, and Strings.

Referenced by C4MapScriptAlgoBorder::C4MapScriptAlgoBorder(), and C4MapScriptAlgoTurbulence::C4MapScriptAlgoTurbulence().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator()()

bool C4MapScriptAlgoLines::operator() ( int32_t  x,
int32_t  y,
uint8_t &  fg,
uint8_t &  bg 
) const
overridevirtual

Implements C4MapScriptAlgo.

Definition at line 211 of file C4MapScriptAlgo.cpp.

212 {
213  // Evaluate MAPALGO_Lines at x,y: Return 1 for pixels contained in lines, 0 for pixels between lines
214  int64_t ax = int64_t(x)-ox;
215  int64_t ay = int64_t(y)-oy;
216  int64_t line_pos = (ax*lx + ay*ly) % dl;
217  if (line_pos < 0) line_pos += dl;
218  return line_pos < ll;
219 }

The documentation for this class was generated from the following files: