occtl_prim_helix_info Struct Reference

#include <occtl_prim_sketch.h>

Collaboration diagram for occtl_prim_helix_info:

Public Attributes
uint32_t	struct_version
const void *	p_next
occtl_axis2_placement_t	placement
double	radius
double	pitch
double	height
int32_t	left_handed

Detailed Description

Info for occtl_prim_make_helix.

Builds a Wire on a helical edge of radius, pitch (height gained per full turn), and total height. The helix winds around the Z axis of placement, centred at placement.location. Right-handedness is the default (counter-clockwise rotation as the helix advances along +Z).

Member Data Documentation

height

double occtl_prim_helix_info::height

Total helix height along Z; strictly positive.

left_handed

int32_t occtl_prim_helix_info::left_handed

0 (default) = right-handed. 1 = left-handed (CW from +Z).

p_next

const void* occtl_prim_helix_info::p_next

Reserved; must be NULL.

pitch

double occtl_prim_helix_info::pitch

Height per turn; strictly positive.

placement

occtl_axis2_placement_t occtl_prim_helix_info::placement

Local frame; helix axis = Z.

radius

double occtl_prim_helix_info::radius

Strictly positive.

struct_version

uint32_t occtl_prim_helix_info::struct_version

Must be OCCTL_PRIM_HELIX_INFO_VERSION_1.

---

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

• include/occtl/occtl_prim_sketch.h