Collaboration diagram for tools::hatcher:

Public Member Functions
	hatcher ()

virtual	~hatcher ()

bool	compute_polyline (vec3f *listPoints, unsigned int number)
	draw the hatch into the polyline bounding box given in argument You have to get all compute points by the get_points() method Number of points can be get by number_of_points() The number of vertices in the return polyline can be get by number_of_vertices() and vertice table by get_vertices More...

bool	check_polyline (vec3f *listPoints, unsigned int number)
	test if the polygone given is correct for hatching More...

void	set_spacing (float a)

void	set_angle (float a)

void	set_offset (float a)

void	set_offset_point (vec3f a)

void	set_precision_factor (float a)

bool	set_strip_width (float a)

float	get_spacing () const

float	get_angle () const

float	get_offset () const

const vec3f &	get_offset_point ()

float	get_precision_factor () const

float	get_strip_width () const

const vec3f &	get_normal ()

const std::vector< vec3f > &	points ()
	vector of compute points Be careful with this function because it can return a set of non convex polygone if you have a non convex polygone at beginning !So, when you want to draw it, you have to use a tesselisation algorithm first More...

const std::vector< unsigned int > &	vertices ()
	vector of numbers of vertices More...

Protected Types
enum	ResolveErrors { RESOLVE_OK = 0, RESOLVE_COLINEAR, RESOLVE_Z_ERROR, RESOLVE_PRECISION_ERROR, RESOLVE_UNDEFINED }

Protected Member Functions
	hatcher (const hatcher &a_from)

hatcher &	operator= (const hatcher &a_from)

bool	compute_single_polyline (vec3f *listPoints, unsigned int number)
	draw the hatch into the polyline bounding box given in argument More...

vec2f	resolve_system (const vec3f &A, const vec3f &B, const vec3f &C)
	Compute a vector system equation aA+bB=C return SbVec2f(0,0) if there is an error set the resolveResult variable to the error code : COLINEAR if A and B are PRECISION_ERROR if there is a lack of precision in computing Z_ERROR if there s no solution for Z UNDEFINED never throw return a SbVec2f for result. More...

Protected Attributes
vec3f	fNormal
	normal vector for the current polyline More...

float	fShift
	Spacing vector between two hatch. More...

float	fDirAngle
	The angle (given in radians) is the one between the first line (point 1-point0) and the hatch lines, in the polyline plan. More...

float	fOffsetValue
	between 0-1. More...

vec3f	fOffset
	first point of the hatch. More...

vec3f	fShiftVec
	Orientation vector for the hatch More...

float	fPrecisionFactor
	factor for compute error between two points More...

vec3f	fDirVec
	hatch direction Vector More...

float	fStripWidth
	strip with size : set to 0 by default between 0 and 1.0 means no strip, 0.5 means strip size is half of distance between two hatches More...

std::vector< vec3f >	fPoints
	vector list of points More...

std::vector< unsigned int >	fVertices
	vector vertices number More...

std::vector< std::vector< int > >	fConflictNumHatchLineTab
	conflict line table More...

std::vector< float >	fHatchShiftToMatchPointVec
	hatchShiftToMatchPointVec tab More...

int	fFirstNumHatch
	first hatch number to draw More...

unsigned int	fNumberHatchToDraw
	number of hatch to draw More...

bool	fFirstPolyline

ResolveErrors	fResolveResult

Detailed Description

Definition at line 56 of file hatcher.

Member Enumeration Documentation

◆ ResolveErrors

enum tools::hatcher::ResolveErrors

protected

Enumerator
RESOLVE_OK
RESOLVE_COLINEAR
RESOLVE_Z_ERROR
RESOLVE_PRECISION_ERROR
RESOLVE_UNDEFINED

Definition at line 258 of file hatcher.

                     {
     RESOLVE_OK = 0,
     RESOLVE_COLINEAR,
     RESOLVE_Z_ERROR,
     RESOLVE_PRECISION_ERROR,
     RESOLVE_UNDEFINED
   };

Constructor & Destructor Documentation

◆ hatcher() [1/2]

tools::hatcher::hatcher ( )

inline

Definition at line 58 of file hatcher.

   :fShift(.1f)
   ,fDirAngle(fpi()/4)
   ,fOffsetValue(.0f)
   ,fOffset(vec3f(FLT_MAX,FLT_MAX,FLT_MAX))
   ,fPrecisionFactor (.0001f) // good value to get rid of some errors
   ,fStripWidth(0.0)
   ,fFirstNumHatch(0)
   ,fNumberHatchToDraw(0)
   ,fFirstPolyline(true)
   ,fResolveResult(RESOLVE_UNDEFINED)
   {}

◆ ~hatcher()

virtual tools::hatcher::~hatcher ( )

inlinevirtual

Definition at line 70 of file hatcher.

70 {}

◆ hatcher() [2/2]

tools::hatcher::hatcher ( const hatcher & a_from )

inlineprotected

Definition at line 72 of file hatcher.

   :fNormal(a_from.fNormal)
   ,fShift(a_from.fShift)
   ,fDirAngle(a_from.fDirAngle)
   ,fOffsetValue(a_from.fOffsetValue)
   ,fOffset(a_from.fOffset)
   ,fShiftVec(a_from.fShiftVec)
   ,fPrecisionFactor(a_from.fPrecisionFactor)
   ,fDirVec(a_from.fDirVec)
   ,fStripWidth(a_from.fStripWidth)
   ,fPoints(a_from.fPoints)
   ,fVertices(a_from.fVertices)
   ,fConflictNumHatchLineTab(a_from.fConflictNumHatchLineTab)
   ,fHatchShiftToMatchPointVec(a_from.fHatchShiftToMatchPointVec)
   ,fFirstNumHatch(a_from.fFirstNumHatch)
   ,fNumberHatchToDraw(a_from.fNumberHatchToDraw)
   ,fFirstPolyline(a_from.fFirstPolyline)
   ,fResolveResult(a_from.fResolveResult)
   {}

Member Function Documentation

◆ check_polyline()

bool tools::hatcher::check_polyline	(	vec3f *	listPoints,
		unsigned int	number
	)

test if the polygone given is correct for hatching

Returns

FALSE if :

All points are not in the same plan
Number of points <3
Offset point is not in the same plan
There is less than three different points
The vector from point[0],point[1] is colinear to point[0],lastPoint

◆ compute_polyline()

bool tools::hatcher::compute_polyline	(	vec3f *	listPoints,
		unsigned int	number
	)

draw the hatch into the polyline bounding box given in argument You have to get all compute points by the get_points() method Number of points can be get by number_of_points() The number of vertices in the return polyline can be get by number_of_vertices() and vertice table by get_vertices

Returns

FALSE if :

All points are not in the same plan
There is a precision error on one or more point

◆ compute_single_polyline()

bool tools::hatcher::compute_single_polyline	(	vec3f *	listPoints,
		unsigned int	number
	)

protected

draw the hatch into the polyline bounding box given in argument

Returns

FALSE if :

All points are not in the same plan
There is a precision error on one or more point

◆ get_angle()

float tools::hatcher::get_angle ( ) const

inline

Definition at line 153 of file hatcher.

153 {return fDirAngle;}

◆ get_normal()

const vec3f& tools::hatcher::get_normal ( )

inline

Definition at line 158 of file hatcher.

158 {return fNormal;}

◆ get_offset()

float tools::hatcher::get_offset ( ) const

inline

Definition at line 154 of file hatcher.

154 {return fOffsetValue;}

◆ get_offset_point()

const vec3f& tools::hatcher::get_offset_point ( )

inline

Definition at line 155 of file hatcher.

155 {return fOffset;}

◆ get_precision_factor()

float tools::hatcher::get_precision_factor ( ) const

inline

Definition at line 156 of file hatcher.

156 {return fPrecisionFactor;}

◆ get_spacing()

float tools::hatcher::get_spacing ( ) const

inline

Definition at line 152 of file hatcher.

152 {return fShift;}

◆ get_strip_width()

float tools::hatcher::get_strip_width ( ) const

inline

Definition at line 157 of file hatcher.

157 {return fStripWidth;}

◆ operator=()

hatcher& tools::hatcher::operator= ( const hatcher & a_from )

inlineprotected

Definition at line 91 of file hatcher.

                                            {
     fNormal = a_from.fNormal;
     fShift = a_from.fShift;
     fDirAngle = a_from.fDirAngle;
     fOffsetValue = a_from.fOffsetValue;
     fOffset = a_from.fOffset;
     fShiftVec = a_from.fShiftVec;
     fPrecisionFactor = a_from.fPrecisionFactor;
     fDirVec = a_from.fDirVec;
     fStripWidth = a_from.fStripWidth;
     fPoints = a_from.fPoints;
     fVertices = a_from.fVertices;
     fConflictNumHatchLineTab = a_from.fConflictNumHatchLineTab;
     fHatchShiftToMatchPointVec = a_from.fHatchShiftToMatchPointVec;
     fFirstNumHatch = a_from.fFirstNumHatch;
     fNumberHatchToDraw = a_from.fNumberHatchToDraw;
     fFirstPolyline = a_from.fFirstPolyline;
     fResolveResult = a_from.fResolveResult;
     return *this;
   }

◆ points()

const std::vector<vec3f>& tools::hatcher::points ( )

inline

vector of compute points
Be careful with this function because it can return a set of non convex polygone if you have a non convex polygone at beginning !So, when you want to draw it, you have to use a tesselisation algorithm first

Definition at line 166 of file hatcher.

166 {return fPoints;}

◆ resolve_system()

vec2f tools::hatcher::resolve_system	(	const vec3f &	A,
		const vec3f &	B,
		const vec3f &	C
	)

protected

Compute a vector system equation aA+bB=C return SbVec2f(0,0) if there is an error set the resolveResult variable to the error code : COLINEAR if A and B are PRECISION_ERROR if there is a lack of precision in computing Z_ERROR if there s no solution for Z UNDEFINED never throw return a SbVec2f for result.

a is 'x' value and b is 'y' if it is correct

◆ set_angle()

void tools::hatcher::set_angle ( float a )

inline

Definition at line 137 of file hatcher.

137 {fDirAngle = a;} //set the Direction angle for the hatch in radians.

◆ set_offset()

void tools::hatcher::set_offset ( float a )

inline

Definition at line 138 of file hatcher.

138 {fOffsetValue = a;} //set the offset value for this hatch.

◆ set_offset_point()

void tools::hatcher::set_offset_point ( vec3f a )

inline

Definition at line 139 of file hatcher.

139 {fOffset = a;} //set the offset Point for this hatch.

◆ set_precision_factor()

void tools::hatcher::set_precision_factor ( float a )

inline

Definition at line 140 of file hatcher.

140 {fPrecisionFactor = a;} //set the precision factor for computing (0.0001 is default).

◆ set_spacing()

void tools::hatcher::set_spacing ( float a )

inline

Definition at line 136 of file hatcher.

136 {fShift = a;} //set the spacing for this hatch.

◆ set_strip_width()

bool tools::hatcher::set_strip_width ( float a )

inline

Definition at line 142 of file hatcher.

                                 {
     // set the strip width value(0 is default and means no strip).
     if (a<0 || a>1) {
       fStripWidth = 0;
       return false;
     }
     fStripWidth = a;
     return true;
   }

◆ vertices()

const std::vector<unsigned int>& tools::hatcher::vertices ( )

inline

vector of numbers of vertices

Definition at line 170 of file hatcher.

170 {return fVertices;}

Member Data Documentation

◆ fConflictNumHatchLineTab

std::vector< std::vector<int> > tools::hatcher::fConflictNumHatchLineTab

protected

conflict line table

Definition at line 246 of file hatcher.

◆ fDirAngle

float tools::hatcher::fDirAngle

protected

The angle (given in radians) is the one between the first line (point 1-point0) and the hatch lines, in the polyline plan.

Given in the direct axis ((point1-point0),(lastPoint-point0), normalPlanVec). The angle in compute only one time for the first polyline. Changes on angle value for others polyline will not take effect.This is to perform correct hatching between the polylines

Definition at line 210 of file hatcher.

◆ fDirVec

vec3f tools::hatcher::fDirVec

protected

hatch direction Vector

Definition at line 231 of file hatcher.

◆ fFirstNumHatch

int tools::hatcher::fFirstNumHatch

protected

first hatch number to draw

Definition at line 252 of file hatcher.

◆ fFirstPolyline

bool tools::hatcher::fFirstPolyline

protected

Definition at line 257 of file hatcher.

◆ fHatchShiftToMatchPointVec

std::vector<float> tools::hatcher::fHatchShiftToMatchPointVec

protected

hatchShiftToMatchPointVec tab

Definition at line 249 of file hatcher.

◆ fNormal

vec3f tools::hatcher::fNormal

protected

normal vector for the current polyline

Definition at line 198 of file hatcher.

◆ fNumberHatchToDraw

unsigned int tools::hatcher::fNumberHatchToDraw

protected

number of hatch to draw

Definition at line 255 of file hatcher.

◆ fOffset

vec3f tools::hatcher::fOffset

protected

first point of the hatch.

offset = firstPolylinePoint+ShiftVec*offsetValue

Definition at line 222 of file hatcher.

◆ fOffsetValue

float tools::hatcher::fOffsetValue

protected

between 0-1.

This value set the offset of the hatch.0 meen that the hatch will touch the first point of the polyline, and 1 meen that first hatch will be draw at a 'spacing' distance to first point

Definition at line 217 of file hatcher.

◆ fPoints

std::vector<vec3f> tools::hatcher::fPoints

protected

vector list of points

Definition at line 240 of file hatcher.

◆ fPrecisionFactor

float tools::hatcher::fPrecisionFactor

protected

factor for compute error between two points

Definition at line 228 of file hatcher.

◆ fResolveResult

ResolveErrors tools::hatcher::fResolveResult

protected

Definition at line 265 of file hatcher.

◆ fShift

float tools::hatcher::fShift

protected

Spacing vector between two hatch.

Definition at line 201 of file hatcher.

◆ fShiftVec

vec3f tools::hatcher::fShiftVec

protected

Orientation vector for the hatch

Definition at line 225 of file hatcher.

◆ fStripWidth

float tools::hatcher::fStripWidth

protected

strip with size : set to 0 by default between 0 and 1.0 means no strip, 0.5 means strip size is half of distance between two hatches

Definition at line 237 of file hatcher.

◆ fVertices

std::vector<unsigned int> tools::hatcher::fVertices

protected

vector vertices number

Definition at line 243 of file hatcher.

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

/Users/barrand/private/dev/softinex/g4tools/g4tools/tools/hatcher

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ResolveErrors

Constructor & Destructor Documentation

◆ hatcher() [1/2]

◆ ~hatcher()

◆ hatcher() [2/2]

Member Function Documentation

◆ check_polyline()

◆ compute_polyline()

◆ compute_single_polyline()

◆ get_angle()

◆ get_normal()

◆ get_offset()

◆ get_offset_point()

◆ get_precision_factor()

◆ get_spacing()

◆ get_strip_width()

◆ operator=()

◆ points()

◆ resolve_system()

◆ set_angle()

◆ set_offset()

◆ set_offset_point()

◆ set_precision_factor()

◆ set_spacing()

◆ set_strip_width()

◆ vertices()

Member Data Documentation

◆ fConflictNumHatchLineTab

◆ fDirAngle

◆ fDirVec

◆ fFirstNumHatch

◆ fFirstPolyline

◆ fHatchShiftToMatchPointVec

◆ fNormal

◆ fNumberHatchToDraw

◆ fOffset

◆ fOffsetValue

◆ fPoints

◆ fPrecisionFactor

◆ fResolveResult

◆ fShift

◆ fShiftVec

◆ fStripWidth

◆ fVertices