hscmap.shape module

class hscmap.shape.ShapeBase[source]

Bases: ABC

abstract paths()[source]
Return type:

Iterable[Path]

class hscmap.shape.ShapeList(shapes: List[hscmap.shape.ShapeBase])[source]

Bases: ShapeBase

Parameters:

shapes (List[ShapeBase]) –

shapes: List[ShapeBase]
paths()[source]
Return type:

Iterable[Path]

class hscmap.shape.Polyline(points: List[hscmap.vec3.SkyCoord | hscmap.vec3.Vec3], color: List[float], close: bool = False)[source]

Bases: ShapeBase

Parameters:

  • points (List[SkyCoord | Vec3]) –

  • color (List[float]) –

  • close (bool) –

points: List[SkyCoord | Vec3]
color: List[float]
close: bool = False
paths()[source]
Return type:

Iterable[Path]

class hscmap.shape.Polygon(center: Union[hscmap.vec3.SkyCoord, hscmap.vec3.Vec3], radius: hscmap.angle.Angle, n: int, up: hscmap.vec3.Vec3 = <factory>, color: List[float] = <factory>)[source]

Bases: ShapeBase

Parameters:
center: SkyCoord | Vec3
radius: Angle
n: int
up: Vec3
color: List[float]
paths()[source]
Return type:

Iterable[Path]

class hscmap.shape.Grid(center: Union[hscmap.vec3.SkyCoord, hscmap.vec3.Vec3], width: hscmap.angle.Angle, height: hscmap.angle.Angle, div_x: int, div_y: int, color: List[float], up: hscmap.vec3.Vec3 = <factory>)[source]

Bases: ShapeBase

Parameters:

  • center (SkyCoord | Vec3) –

  • width (Angle) –

  • height (Angle) –

  • div_x (int) –

  • div_y (int) –

  • color (List[float]) –

  • up (Vec3) –

center: SkyCoord | Vec3
width: Angle
height: Angle
div_x: int
div_y: int
color: List[float]
up: Vec3
paths()[source]
Return type:

Iterable[Path]

class hscmap.shape.Line(start: hscmap.vec3.SkyCoord | hscmap.vec3.Vec3, end: hscmap.vec3.SkyCoord | hscmap.vec3.Vec3, color: List[float])[source]

Bases: ShapeBase

Parameters:
start: SkyCoord | Vec3
end: SkyCoord | Vec3
color: List[float]
paths()[source]
Return type:

Iterable[Path]