Classes
class	AdaptiveTileRefinement
	Parameters controlling the adaptive sub-patch refinement of an adaptive tile object. More...

class	AxisRotation
	Axis rotation structure for specifying shoot orientation in PlantArchitecture. More...

class	Date
	Helios Date structure for representing date values. More...

class	int2

class	int3

class	int4

class	Location
	Geographic location for solar position and radiation calculations. More...

class	PrimitiveType
	Helios primitive type enumeration. More...

class	RGBAcolor

class	RGBcolor

class	SphericalCoord

class	Time
	Helios Time structure for representing time values. More...

class	vec2

class	vec3

class	vec4

class	VertexNormalSource
	Provenance of a polymesh object's per-vertex normals (helios-core 1.3.83). More...

class	VertexWeldMode
	Granularity at which coincident vertices are treated as one shared vertex (helios-core 1.3.84). More...

Functions
int2	make_int2 (int x, int y)
	Make an int2 from two integers.

SphericalCoord	make_SphericalCoord (float elevation_radians, float azimuth_radians)
	Make a SphericalCoord by specifying elevation and azimuth (C++ API compatibility).

int3	make_int3 (int x, int y, int z)
	Make an int3 from three integers.

int4	make_int4 (int x, int y, int z, int w)
	Make an int4 from four integers.

vec2	make_vec2 (float x, float y)
	Make a vec2 from two floats.

vec3	make_vec3 (float x, float y, float z)
	Make a vec3 from three floats.

vec4	make_vec4 (float x, float y, float z, float w)
	Make a vec4 from four floats.

RGBcolor	make_RGBcolor (float r, float g, float b)
	Make an RGBcolor from three floats.

RGBAcolor	make_RGBAcolor (float r, float g, float b, float a)
	Make an RGBAcolor from four floats.

AxisRotation	make_AxisRotation (float pitch, float yaw, float roll)
	Make an AxisRotation from three angles in degrees.

Time	make_Time (int hour, int minute, int second)
	Make a Time from hour, minute, second.

Date	make_Date (int year, int month, int day)
	Make a Date from year, month, day.

Location	make_Location (float latitude, float longitude, float utc_offset, float altitude=0.0)
	Make a Location from latitude (deg), longitude (deg), UTC offset (hours), and altitude (m).

Function Documentation

◆ make_AxisRotation()

AxisRotation pyhelios.wrappers.DataTypes.make_AxisRotation	(	float	pitch,
		float	yaw,
		float	roll )

Make an AxisRotation from three angles in degrees.

Definition at line 838 of file DataTypes.py.

◆ make_Date()

Date pyhelios.wrappers.DataTypes.make_Date	(	int	year,
		int	month,
		int	day )

Make a Date from year, month, day.

Definition at line 1020 of file DataTypes.py.

◆ make_int2()

int2 pyhelios.wrappers.DataTypes.make_int2	(	int	x,
		int	y )

Make an int2 from two integers.

Definition at line 793 of file DataTypes.py.

◆ make_int3()

int3 pyhelios.wrappers.DataTypes.make_int3	(	int	x,
		int	y,
		int	z )

Make an int3 from three integers.

Definition at line 810 of file DataTypes.py.

◆ make_int4()

int4 pyhelios.wrappers.DataTypes.make_int4	(	int	x,
		int	y,
		int	z,
		int	w )

Make an int4 from four integers.

Definition at line 814 of file DataTypes.py.

◆ make_Location()

Location pyhelios.wrappers.DataTypes.make_Location	(	float	latitude,
		float	longitude,
		float	utc_offset,
		float	altitude = 0.0 )

Make a Location from latitude (deg), longitude (deg), UTC offset (hours), and altitude (m).

Definition at line 1113 of file DataTypes.py.

◆ make_RGBAcolor()

RGBAcolor pyhelios.wrappers.DataTypes.make_RGBAcolor	(	float	r,
		float	g,
		float	b,
		float	a )

Make an RGBAcolor from four floats.

Definition at line 834 of file DataTypes.py.

◆ make_RGBcolor()

RGBcolor pyhelios.wrappers.DataTypes.make_RGBcolor	(	float	r,
		float	g,
		float	b )

Make an RGBcolor from three floats.

Definition at line 830 of file DataTypes.py.

◆ make_SphericalCoord()

SphericalCoord pyhelios.wrappers.DataTypes.make_SphericalCoord	(	float	elevation_radians,
		float	azimuth_radians )

Make a SphericalCoord by specifying elevation and azimuth (C++ API compatibility).

Parameters

elevation_radians	Elevation angle in radians
azimuth_radians	Azimuthal angle in radians

Returns: SphericalCoord with radius=1, and automatically computed zenith

Definition at line 806 of file DataTypes.py.

◆ make_Time()

Time pyhelios.wrappers.DataTypes.make_Time	(	int	hour,
		int	minute,
		int	second )

Make a Time from hour, minute, second.

Definition at line 1016 of file DataTypes.py.

◆ make_vec2()

vec2 pyhelios.wrappers.DataTypes.make_vec2	(	float	x,
		float	y )

Make a vec2 from two floats.

Definition at line 818 of file DataTypes.py.

◆ make_vec3()

vec3 pyhelios.wrappers.DataTypes.make_vec3	(	float	x,
		float	y,
		float	z )

Make a vec3 from three floats.

Definition at line 822 of file DataTypes.py.

◆ make_vec4()

vec4 pyhelios.wrappers.DataTypes.make_vec4	(	float	x,
		float	y,
		float	z,
		float	w )

Make a vec4 from four floats.

Definition at line 826 of file DataTypes.py.

Classes

Functions