lop_options Class Reference
[Local Operations]

Options for local operations. More...

#include <lop_opts.hxx>

Inheritance diagram for lop_options:

Collaboration diagram for lop_options:

List of all members.

Public Member Functions

void clear_remove_face_info ()

Clear the remove face information.Internal book keeping.

logical get_check_remote_face_face_intersections () const

Gets the status of the check_remote_face_face_intersections flag.

offset_options get_offset_options ()

Gets offsetting options.

VOID_LIST & get_remove_face_info ()

Returns a list of remove_face_info structures contained in a VOID_LIST.

logical get_repair_self_int () const

Gets the status of the repair_self_intersections flag.

logical get_simplify () const

Gets the status of simplify flag, which specifies whether the offset spline surface is to be simplified.

vent_type_id get_vent_type ()

Gets the type of vent face addition behavior.

lop_options (const lop_options &rRhs)

C++ copy constructor.

lop_options ()

C++ allocation constructor requests memory for this object but does not populate it.

logical operator!= (const lop_options &rRhs)

Non-equals operator.

lop_options & operator= (const lop_options &rRhd)

Assignment Copy Operator for lop_options.

logical operator== (const lop_options &rRhs)

Equals Operator.

void set_check_remote_face_face_intersections (logical bVal)

Sets the check_remote_face_face_intersections to the given value.

void set_repair_self_int (logical bVal)

Sets the repair_self_intersections flag to the given value.

void set_simplify (ofst_simplify_state bVal)

Sets the simplify flag, which specifies whether the offset spline surface is to be simplified.

void set_vent_type (vent_type_id ventType)

Sets the type of vent face addition behavior.

void verify_version ()

Sets values according to the version context.

~lop_options ()

C++ default destructor.

Private Member Functions

void init ()

Internal initialization.

Private Attributes

logical _check_remote_face_face_intersections

Check and repair intersections between remote face pairs.

offset_options _mOffsetOpts

Offset options (currently contains simplify option).

logical _mRepairSelfIntersections

Check and repair self-intersections.

vent_type_id _mVentType

Vent face behavior for some Local Operations.

VOID_LIST _remove_face_info

Remove face information.

KERN_PROTECTED_LIST * _remove_face_info_internal

Remove face information.

Detailed Description

Options for local operations.

Role : This class contains information to be used to control the behavior and/or results of Local Operations.
This option class is discussed in Local Operations Options. They include :

repair_self_intersections Specifies whether to inspect and repair self-intersections caused by the Local Operation. Default value is TRUE.

simplify Specifies whether to simplify the offset spline surfaces to analytic surfaces, if possible. Default value for this flag is TRUE. This option replaces functionality of the global option lop_simplify.

check_remote_face_face_intersections Specifies whether to inspect and repair intersections between remote pairs of faces caused by the Local Operation. Meaningful only if the repair_self_intersections option is TRUE. Default value is FALSE. If repair_self_intersections is TRUE and this option is FALSE, only local repair of individual faces is done.

vent_type Sets the behavior for vent face addition. Local operations may cause two faces that are originally connected through a tangent edge to separate. The gap between the two faces can be closed in some cases by extending the surfaces of the new faces and intersecting. An alternate approach for closing the gap is to insert a new face which is perpendicular to the two faces. This new face is called a vent face. Currently, this option only affects operations involving tapering and offsetting; it does not affect move and remove operations. For shelling, this option controls vent face addition only during the offsetting phase of the operation, but does not control the addition of vent faces around open faces in hollow-body operations and does not control the addition of vent faces between rim faces in sheet-thicken operations. There are four possible values of type vent_type_id :

vent_type_none : Always tries to fill the gap between the faces by extending and intersecting the faces.

vent_type_add (default): Allows the gap between the faces to be filled by adding vent faces. The specific circumstances for adding vent faces vary by operation.

vent_type_taper : Not used.

vent_face_always : Always fills the gap by adding a vent face. Currently used only in offsetting.

In addition, after a Remove Face operation the options object contains information about the Remove Faces operation. For example, it will contain a list of edges that result from a removing face.

Constructor & Destructor Documentation

lop_options::lop_options ( )

C++ allocation constructor requests memory for this object but does not populate it.

lop_options::lop_options ( const lop_options & rRhs )

C++ copy constructor.

Parameters:

rRhs

lop_options to copy.

lop_options::~lop_options ( )

C++ default destructor.

Member Function Documentation

void lop_options::clear_remove_face_info ( )

Clear the remove face information.Internal book keeping.

Do not use.

logical lop_options::get_check_remote_face_face_intersections ( ) const

Gets the status of the check_remote_face_face_intersections flag.

offset_options lop_options::get_offset_options ( )

Gets offsetting options.

VOID_LIST& lop_options::get_remove_face_info ( )

Returns a list of remove_face_info structures contained in a VOID_LIST.

They contain information about a face removed in a blend sequence. Each object has a pointer to the face that's been removed and then a list of entities (at this time there should just be one entity in the list). There will be either a vertex or edge in the list of entities.

logical lop_options::get_repair_self_int ( ) const

Gets the status of the repair_self_intersections flag.

logical lop_options::get_simplify ( ) const

Gets the status of simplify flag, which specifies whether the offset spline surface is to be simplified.

vent_type_id lop_options::get_vent_type ( )

Gets the type of vent face addition behavior.

void lop_options::init ( ) [private]

Internal initialization.

logical lop_options::operator!= ( const lop_options & rRhs )

Non-equals operator.

Parameters:

rRhs

lop_options to be compared.

lop_options& lop_options::operator= ( const lop_options & rRhd )

Assignment Copy Operator for lop_options.

Note: It does not copy any remove face info data.

Parameters:

rRhd

Option Object to be copied/assigned.

logical lop_options::operator== ( const lop_options & rRhs )

Equals Operator.

Note: It does not compare any remove face info data.

Parameters:

rRhs

lop_options to be compared.

void lop_options::set_check_remote_face_face_intersections ( logical bVal )

Sets the check_remote_face_face_intersections to the given value.

Parameters:

bVal

New value.

void lop_options::set_repair_self_int ( logical bVal )

Sets the repair_self_intersections flag to the given value.

Parameters:

bVal

New value.

void lop_options::set_simplify ( ofst_simplify_state bVal )

Sets the simplify flag, which specifies whether the offset spline surface is to be simplified.

Parameters:

bVal

New value.

void lop_options::set_vent_type ( vent_type_id ventType )

Sets the type of vent face addition behavior.

Parameters:

ventType

Vent face behavior expected for some local operations.

void lop_options::verify_version ( )

Sets values according to the version context.

Member Data Documentation

logical lop_options::_check_remote_face_face_intersections [private]

Check and repair intersections between remote face pairs.

offset_options lop_options::_mOffsetOpts [private]

Offset options (currently contains simplify option).

logical lop_options::_mRepairSelfIntersections [private]

Check and repair self-intersections.

vent_type_id lop_options::_mVentType [private]

Vent face behavior for some Local Operations.

VOID_LIST lop_options::_remove_face_info [private]

Remove face information.

KERN_PROTECTED_LIST* lop_options::_remove_face_info_internal [private]

Remove face information.

For internal use only.


Public Member Functions
void	clear_remove_face_info ()
	Clear the remove face information.Internal book keeping.
logical	get_check_remote_face_face_intersections () const
	Gets the status of the `check_remote_face_face_intersections` flag.
offset_options	get_offset_options ()
	Gets offsetting options.
VOID_LIST &	get_remove_face_info ()
	Returns a list of `remove_face_info` structures contained in a `VOID_LIST`.
logical	get_repair_self_int () const
	Gets the status of the `repair_self_intersections` flag.
logical	get_simplify () const
	Gets the status of `simplify` flag, which specifies whether the offset spline surface is to be simplified.
vent_type_id	get_vent_type ()
	Gets the type of vent face addition behavior.
	lop_options (const lop_options &rRhs)
	C++ copy constructor.
	lop_options ()
	C++ allocation constructor requests memory for this object but does not populate it.
logical	operator!= (const lop_options &rRhs)
	Non-equals operator.
lop_options &	operator= (const lop_options &rRhd)
	Assignment Copy Operator for `lop_options`.
logical	operator== (const lop_options &rRhs)
	Equals Operator.
void	set_check_remote_face_face_intersections (logical bVal)
	Sets the `check_remote_face_face_intersections` to the given value.
void	set_repair_self_int (logical bVal)
	Sets the `repair_self_intersections` flag to the given value.
void	set_simplify (ofst_simplify_state bVal)
	Sets the `simplify` flag, which specifies whether the offset spline surface is to be simplified.
void	set_vent_type (vent_type_id ventType)
	Sets the type of vent face addition behavior.
void	verify_version ()
	Sets values according to the version context.
	~lop_options ()
	C++ default destructor.
Private Member Functions
void	init ()
	Internal initialization.
Private Attributes
logical	_check_remote_face_face_intersections
	Check and repair intersections between remote face pairs.
offset_options	_mOffsetOpts
	Offset options (currently contains `simplify` option).
logical	_mRepairSelfIntersections
	Check and repair self-intersections.
vent_type_id	_mVentType
	Vent face behavior for some Local Operations.
VOID_LIST	_remove_face_info
	Remove face information.
KERN_PROTECTED_LIST *	_remove_face_info_internal
	Remove face information.

`repair_self_intersections`	Specifies whether to inspect and repair self-intersections caused by the Local Operation. Default value is `TRUE`.
`simplify`	Specifies whether to simplify the offset spline surfaces to analytic surfaces, if possible. Default value for this flag is `TRUE`. This option replaces functionality of the global option `lop_simplify`.
`check_remote_face_face_intersections`	Specifies whether to inspect and repair intersections between remote pairs of faces caused by the Local Operation. Meaningful only if the `repair_self_intersections` option is `TRUE`. Default value is `FALSE`. If `repair_self_intersections` is `TRUE` and this option is `FALSE`, only local repair of individual faces is done.
`vent_type`	Sets the behavior for vent face addition. Local operations may cause two faces that are originally connected through a tangent edge to separate. The gap between the two faces can be closed in some cases by extending the surfaces of the new faces and intersecting. An alternate approach for closing the gap is to insert a new face which is perpendicular to the two faces. This new face is called a vent face. Currently, this option only affects operations involving tapering and offsetting; it does not affect move and remove operations. For shelling, this option controls vent face addition only during the offsetting phase of the operation, but does not control the addition of vent faces around open faces in hollow-body operations and does not control the addition of vent faces between rim faces in sheet-thicken operations. There are four possible values of type vent_type_id : `vent_type_none` : Always tries to fill the gap between the faces by extending and intersecting the faces. `vent_type_add` (default): Allows the gap between the faces to be filled by adding vent faces. The specific circumstances for adding vent faces vary by operation. `vent_type_taper` : Not used. `vent_face_always` : Always fills the gap by adding a vent face. Currently used only in offsetting.

lop_options Class Reference [Local Operations]

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

lop_options Class Reference
[Local Operations]