wire_offset_options Class Reference
[Offset Face and Wire]

Provides a data structure for wire offsetting operations to be used in the function api_offset_planar_wire. More...

#include <wire_offset_options.hxx>

Inheritance diagram for wire_offset_options:

[legend]

Collaboration diagram for wire_offset_options:

[legend]

List of all members.

Public Member Functions
int	get_add_attribs () const
	Returns the current value of the add_attribs option.
law *	get_distance_law () const
	Returns the distance option.
sg_gap_type	get_gap_type () const
	Returns the current value of the gap_type option.
int	get_keep_minimum_topology () const
	Returns the current value of the keep_minimum_topology option.
int	get_overlap () const
	Returns the current value of the overlap option.
SPAunit_vector	get_plane_normal () const
	Returns the current value of the plane_normal option.
int	get_trim () const
	Returns the current value of the trim option.
law *	get_twist_law () const
	Returns the twist option.
int	get_zero_length () const
	Returns the current value of the zero_length option.
int	operator!= (const wire_offset_options &iSrcOpt)
	Verifies whether this option instance is not equal to the given offset option.
int	operator== (const wire_offset_options &iSrcOpt)
	Verifies whether this option instance is equal to the given offset option.
void	set_add_attribs (int iStatus)
	Sets the value of the add_attribs option.
void	set_distance (double iDistance)
	Sets the distance option.
void	set_distance (law *iDistLaw)
	Sets the distance option.
void	set_gap_type (sg_gap_type iGapType)
	Sets the gap filling type.
void	set_keep_minimum_topology (int iStatus)
	Sets the value of the keep_minimum_topology option.
void	set_overlap (int iStatus)
	Sets the value of the overlap option.
void	set_plane_normal (const SPAunit_vector &iNormal)
	Sets the value of the plane_normal option.
void	set_trim (int iStatus)
	Sets the value of the trim option.
void	set_twist_law (law *iTwistLaw)
	Sets the twist_law option.
void	set_zero_length (int iStatus)
	Sets the value of the zero_length option.
	wire_offset_options ()
	Default constructor.
	~wire_offset_options ()
	Default destructor.

---

Detailed Description

Provides a data structure for wire offsetting operations to be used in the function api_offset_planar_wire.

Role: This class holds various options for the wire offset operation. The following lists the options:

• distance: This option specifies the offset distance. It is represented by a law. The default value is a NULL law.
• gap_type: This option specifies the type of gap to be placed when the offsets of adjacent, nontangential wire edges do not touch at a common vertex. The type can be:
  • "extended" which linearly extends the offset curves along their tangents until they intersect (that is, creates a corner),
  • "rounded" which connects the endpoints with a tangential arc, or
  • "natural" which extends the curves using curvature extension rather than linear extension.
  Presently, the gap type "natural" might be done with a linear extension if curvature extension cannot be achieved. It might also be done with a rounded extension if the extensions do not intersect. A warning is issued if the gap_type is changed. The default value is "natural".
• keep_minimum_topology: Wire offset might create additional edges for gap fill geometry. These additional edges will not be created if keep_minimum_topology is TRUE. This is done by extending the offset edges. In cases the offset edge cannot be extended, the wire offset operation will fail and an error message is issued. The default value is 0, FALSE.
• overlap: This option specifies whether overlapping segments are to be removed. The default value is 0, FALSE.
• plane_normal: This option specifies the normal vector of the wire plane, which is the plane where the offset wire body lies. The default value is a NULL unit vector.
• trim: This option specifies whether self-intersections are to be removed. The default value is 1, TRUE.
• twist_law: This option specifies the twist law. The default value is a NULL law, implying no twist.
• zero_length: If the option is not set to zero, then the offset will return a zero-length wire when offset to a point. The default value is 0, FALSE.

Note: All the options settings are optional, except distance, which must be specified for a successful wire offsetting operation. If an option is not specified, the default value is used.

---

Constructor & Destructor Documentation

wire_offset_options::wire_offset_options

(

)

Default constructor.

wire_offset_options::~wire_offset_options

(

)

Default destructor.

---

Member Function Documentation

int wire_offset_options::get_add_attribs

(

)

const

Returns the current value of the add_attribs option.

law* wire_offset_options::get_distance_law

(

)

const

Returns the distance option.

sg_gap_type wire_offset_options::get_gap_type

(

)

const

Returns the current value of the gap_type option.

int wire_offset_options::get_keep_minimum_topology

(

)

const

Returns the current value of the keep_minimum_topology option.

int wire_offset_options::get_overlap

(

)

const

Returns the current value of the overlap option.

SPAunit_vector wire_offset_options::get_plane_normal

(

)

const

Returns the current value of the plane_normal option.

int wire_offset_options::get_trim

(

)

const

Returns the current value of the trim option.

law* wire_offset_options::get_twist_law

(

)

const

Returns the twist option.

int wire_offset_options::get_zero_length

(

)

const

Returns the current value of the zero_length option.

int wire_offset_options::operator!=

(

const wire_offset_options &

iSrcOpt

)

Verifies whether this option instance is not equal to the given offset option.

Parameters:

iSrcOpt

source options to test.

int wire_offset_options::operator==

(

const wire_offset_options &

iSrcOpt

)

Verifies whether this option instance is equal to the given offset option.

Parameters:

iSrcOpt

source offset options to test.

void wire_offset_options::set_add_attribs

(

int

iStatus

)

Sets the value of the add_attribs option.

Parameters:

iStatus

new add_attribs option value.

void wire_offset_options::set_distance

(

double

iDistance

)

Sets the distance option.

Role: This signature of set_distance takes a double and converts it into a constant law to represent the offset distance.

Parameters:

iDistance

new distance option value.

void wire_offset_options::set_distance

(

law *

iDistLaw

)

Sets the distance option.

Parameters:

iDistLaw

new distance option value.

void wire_offset_options::set_gap_type

(

sg_gap_type

iGapType

)

Sets the gap filling type.

Parameters:

iGapType

Gap type can be extended, rounded, or natural.

void wire_offset_options::set_keep_minimum_topology

(

int

iStatus

)

Sets the value of the keep_minimum_topology option.

Parameters:

iStatus

new keep_minimum_topology option value.

void wire_offset_options::set_overlap

(

int

iStatus

)

Sets the value of the overlap option.

Parameters:

iStatus

new overlap option value.

void wire_offset_options::set_plane_normal

(

const SPAunit_vector &

iNormal

)

Sets the value of the plane_normal option.

Parameters:

iNormal

new plane_normal option value.

void wire_offset_options::set_trim

(

int

iStatus

)

Sets the value of the trim option.

Parameters:

iStatus

new trim option value.

void wire_offset_options::set_twist_law

(

law *

iTwistLaw

)

Sets the twist_law option.

Parameters:

iTwistLaw

new twist_law option value.

void wire_offset_options::set_zero_length

(

int

iStatus

)

Sets the value of the zero_length option.

Parameters:

iStatus

new zero_length option value.