FastUIDraw
Public Member Functions | List of all members
fastuidraw::PathContour::arc Class Reference

An arc is for connecting one point to the next via an arc of a circle. More...

#include <path.hpp>

Inheritance diagram for fastuidraw::PathContour::arc:
Inheritance graph
[legend]

Public Member Functions

 arc (PathContour &contour, float angle, const vec2 &end, enum PathEnums::edge_type_t tp)
 
virtual enum return_code add_to_builder (ShaderFilledPath::Builder *builder, float tol) const
 
range_type< float > angle (void) const
 
virtual void approximate_bounding_box (Rect *out_bb) const
 
vec2 center (void) const
 
virtual reference_counted_ptr< interpolator_basedeep_copy (PathContour &contour) const
 
virtual bool is_flat (void) const
 
virtual reference_counted_ptr< tessellation_stateproduce_tessellation (const TessellatedPath::TessellationParams &tess_params, TessellatedPath::SegmentStorage *out_data, float *out_max_distance) const
 
- Public Member Functions inherited from fastuidraw::PathContour::interpolator_base
 interpolator_base (PathContour &contour, const vec2 &end, enum PathEnums::edge_type_t tp)
 
enum PathEnums::edge_type_t edge_type (void) const
 
const vec2end_pt (void) const
 
const vec2start_pt (void) const
 
- Public Member Functions inherited from fastuidraw::reference_counted_base< T, Counter >
 reference_counted_base (void)
 

Additional Inherited Members

- Static Public Member Functions inherited from fastuidraw::reference_counted_base< T, Counter >
static void add_reference (const reference_counted_base< T, Counter > *p)
 
static void remove_reference (const reference_counted_base< T, Counter > *p)
 

Detailed Description

An arc is for connecting one point to the next via an arc of a circle.

Definition at line 433 of file path.hpp.

Constructor & Destructor Documentation

◆ arc()

fastuidraw::PathContour::arc::arc ( PathContour contour,
float  angle,
const vec2 end,
enum PathEnums::edge_type_t  tp 
)

Ctor.

Parameters
contourPathContour to which to add the interpolator. The interpolator is added to the contour at the interpolator's construction. The start point is computed from the current state of the PathContour
angleThe angle of the arc in radians, the value must not be a multiple of 2*FASTUIDRAW_PI. Assuming a coordinate system where y-increases vertically and x-increases to the right, a positive value indicates to have the arc go counter-clockwise, a negative angle for the arc to go clockwise.
endend of curve
tpnature the edge represented by this interpolator_base

Member Function Documentation

◆ add_to_builder()

virtual enum return_code fastuidraw::PathContour::arc::add_to_builder ( ShaderFilledPath::Builder builder,
float  tol 
) const
virtual

To be optionally implemented by a derived class to add this interpolator to a ShaderFilledPath::Builder. A return code of routine_fail means that the interpolator cannot be realized in such a way to be added and a Path that includes such an interpolator in a closed contour will be unable to realized a ShaderFilledPath value and Path::shader_filled_path() will return a null handle. Default implementation is to return routine_fail.

Parameters
builderobject to which to add interpolator.
tolerror goal between the interpolator and how it is realized on the ShaderFilledPath::Builder

Reimplemented from fastuidraw::PathContour::interpolator_base.

◆ angle()

range_type<float> fastuidraw::PathContour::arc::angle ( void  ) const

Returns the starting and ending angle of the arc each in radians.

◆ approximate_bounding_box()

virtual void fastuidraw::PathContour::arc::approximate_bounding_box ( Rect out_bb) const
virtual

To be implemented by a derived class to return a fast (and approximate) bounding box for the interpolator.

Parameters
out_bb(output) location to which to write the bounding box value

Implements fastuidraw::PathContour::interpolator_base.

◆ center()

vec2 fastuidraw::PathContour::arc::center ( void  ) const

Returns the center of the arc.

◆ deep_copy()

virtual reference_counted_ptr<interpolator_base> fastuidraw::PathContour::arc::deep_copy ( PathContour contour) const
virtual

To be implemented by a derived class to create and return a deep copy of the interpolator object.

Implements fastuidraw::PathContour::interpolator_base.

◆ is_flat()

virtual bool fastuidraw::PathContour::arc::is_flat ( void  ) const
virtual

To be implemented by a derived class to return true if the interpolator is flat, i.e. is just a line segment connecting start_pt() to end_pt().

Implements fastuidraw::PathContour::interpolator_base.

◆ produce_tessellation()

virtual reference_counted_ptr<tessellation_state> fastuidraw::PathContour::arc::produce_tessellation ( const TessellatedPath::TessellationParams tess_params,
TessellatedPath::SegmentStorage out_data,
float *  out_max_distance 
) const
virtual

To be implemented by a derived class to produce the arc-tessellation from start_pt() to end_pt(). In addition, for recursive tessellation, returns the tessellation state to be queried for recursion depth and reused to refine the tessellation. If the tessellation routine is not recursive in nature, return nullptr.

Parameters
tess_paramstessellation parameters
out_datalocation to which to write the tessellations
out_max_distancelocation to which to write an upperbound for the distance between the curve and the tesseallation approximation.

Implements fastuidraw::PathContour::interpolator_base.


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