libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
LineSegment.h File Reference

Definition of LineSegment_t for SBML Layout_t. More...

Include dependency graph for LineSegment.h:
This graph shows which files directly or indirectly include this file:

Functions

LineSegment_tLineSegment_clone (const LineSegment_t *ls)
 @_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tLineSegment_t_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tls_t _tis_t @_tc_t _tNULL_t.
 
LineSegment_tLineSegment_create (void)
 _tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _tboth_t _tpoints_t _tset_t _tto_t (_t0_t._t0_t,_t0_t._t0_t,_t0_t._t0_t).
 
LineSegment_tLineSegment_createFrom (const LineSegment_t *temp)
 _tCreates_t _ta_t _tclone_t _tof_t @_tp_t _ttemp_t, _tor_t _tcreates_t _ta_t _tnew_t _tempty_t _tLineSegment_t _tif_t @_tp_t _ttemp_t _tis_t @_tc_t _tNULL_t.
 
LineSegment_tLineSegment_createWithCoordinates (double x1, double y1, double z1, double x2, double y2, double z2)
 _tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _tcoordinates_t _tand_t _treturns_t _tthe_t _tpointer_t.
 
LineSegment_tLineSegment_createWithPoints (const Point_t *start, const Point_t *end)
 _tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _tpoints_t _tand_t _treturns_t _tthe_t _tpointer_t.
 
void LineSegment_free (LineSegment_t *ls)
 _tFrees_t _tthe_t _tmemory_t _tfor_t _tthe_t _tline_t _tsegment_t.
 
Point_tLineSegment_getEnd (LineSegment_t *ls)
 _tReturns_t _tthe_t _tend_t _tpoint_t _tof_t _tthe_t _tline_t.
 
Point_tLineSegment_getStart (LineSegment_t *ls)
 _tReturns_t _tthe_t _tstart_t _tpoint_t _tof_t _tthe_t _tline_t.
 
void LineSegment_initDefaults (LineSegment_t *ls)
 _tDoes_t _tnothing_t _tsince_t _tno_t _tdefaults_t _tare_t _tdefined_t _tfor_t _tLineSegment_t_t.
 
void LineSegment_setEnd (LineSegment_t *ls, const Point_t *end)
 _tInitializes_t _tthe_t _tend_t _tpoint_t _twith_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPoint_t_t _tstructure_t.
 
void LineSegment_setStart (LineSegment_t *ls, const Point_t *start)
 _tInitializes_t _tthe_t _tstart_t _tpoint_t _twith_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPoint_t_t _tstructure_t.
 

Detailed Description

Definition of LineSegment_t for SBML Layout_t.

Author
Ralph Gauges

Function Documentation

◆ LineSegment_clone()

LineSegment_t * LineSegment_clone ( const LineSegment_t ls)

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tLineSegment_t_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tls_t _tis_t @_tc_t _tNULL_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_create()

LineSegment_t * LineSegment_create ( void  )

_tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _tboth_t _tpoints_t _tset_t _tto_t (_t0_t._t0_t,_t0_t._t0_t,_t0_t._t0_t).

@_treturn_t _tA_t _tpointer_t _tto_t _tthe_t _tcreated_t _tLineSegment_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLineSegment_t_t

_tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _tboth_t _tpoints_t _tset_t _tto_t (_t0_t._t0_t,_t0_t._t0_t,_t0_t._t0_t).

◆ LineSegment_createFrom()

LineSegment_t * LineSegment_createFrom ( const LineSegment_t temp)

_tCreates_t _ta_t _tclone_t _tof_t @_tp_t _ttemp_t, _tor_t _tcreates_t _ta_t _tnew_t _tempty_t _tLineSegment_t _tif_t @_tp_t _ttemp_t _tis_t @_tc_t _tNULL_t.

@_tparam_t _ttemp_t _tthe_t _tLineSegment_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _tthe_t _tcreated_t _tcopy_t _tof_t _tthe_t _tLineSegment_t_t

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_createWithCoordinates()

LineSegment_t * LineSegment_createWithCoordinates ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2 
)

_tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _tcoordinates_t _tand_t _treturns_t _tthe_t _tpointer_t.

@_tparam_t _tx1_t _tthe_t _tvalue_t _tof_t _tthe_t _tx_t _tcoordinate_t _tof_t _tthe_t _tstart_t _tPoint_t_t. @_tparam_t _ty1_t _tthe_t _tvalue_t _tof_t _tthe_t _ty_t _tcoordinate_t _tof_t _tthe_t _tstart_t _tPoint_t_t. @_tparam_t _tz1_t _tthe_t _tvalue_t _tof_t _tthe_t _tz_t _tcoordinate_t _tof_t _tthe_t _tstart_t _tPoint_t_t. @_tparam_t _tx2_t _tthe_t _tvalue_t _tof_t _tthe_t _tx_t _tcoordinate_t _tof_t _tthe_t _tend_t _tPoint_t_t. @_tparam_t _ty2_t _tthe_t _tvalue_t _tof_t _tthe_t _ty_t _tcoordinate_t _tof_t _tthe_t _tend_t _tPoint_t_t. @_tparam_t _tz2_t _tthe_t _tvalue_t _tof_t _tthe_t _tz_t _tcoordinate_t _tof_t _tthe_t _tend_t _tPoint_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_createWithPoints()

LineSegment_t * LineSegment_createWithPoints ( const Point_t start,
const Point_t end 
)

_tCreates_t _ta_t _tLineSegment_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _tpoints_t _tand_t _treturns_t _tthe_t _tpointer_t.

@_tparam_t _tstart_t _tthe_t _tPoint_t_t _tat_t _twhich_t _tthe_t _tline_t _tsegment_t _tstarts_t. @_tparam_t _tend_t _tthe_t _tPoint_t_t _tat_t _twhich_t _tthe_t _tline_t _tsegment_t _tends_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_free()

void LineSegment_free ( LineSegment_t ls)

_tFrees_t _tthe_t _tmemory_t _tfor_t _tthe_t _tline_t _tsegment_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t.

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_getEnd()

Point_t * LineSegment_getEnd ( LineSegment_t ls)

_tReturns_t _tthe_t _tend_t _tpoint_t _tof_t _tthe_t _tline_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_getStart()

Point_t * LineSegment_getStart ( LineSegment_t ls)

_tReturns_t _tthe_t _tstart_t _tpoint_t _tof_t _tthe_t _tline_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_initDefaults()

void LineSegment_initDefaults ( LineSegment_t ls)

_tDoes_t _tnothing_t _tsince_t _tno_t _tdefaults_t _tare_t _tdefined_t _tfor_t _tLineSegment_t_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t.

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_setEnd()

void LineSegment_setEnd ( LineSegment_t ls,
const Point_t end 
)

_tInitializes_t _tthe_t _tend_t _tpoint_t _twith_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPoint_t_t _tstructure_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t. @_tparam_t _tend_t _tthe_t _tPoint_t_t _tat_t _twhich_t _tthe_t _tline_t _tsegment_t _tends_t.

@_tmemberof_t _tLineSegment_t_t

◆ LineSegment_setStart()

void LineSegment_setStart ( LineSegment_t ls,
const Point_t start 
)

_tInitializes_t _tthe_t _tstart_t _tpoint_t _twith_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPoint_t_t _tstructure_t.

@_tparam_t _tls_t _tthe_t _tLineSegment_t_t _tstructure_t. @_tparam_t _tstart_t _tthe_t _tPoint_t_t _tat_t _twhich_t _tthe_t _tline_t _tsegment_t _tstarts_t.

@_tmemberof_t _tLineSegment_t_t