#include <sprk_parasolid.h>

Inheritance diagram for HPS::Parasolid::LineTessellationKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (LineTessellationKit const &in_kit) const
 
 LineTessellationKit ()
 
 LineTessellationKit (LineTessellationKit const &in_kit)
 
 LineTessellationKit (LineTessellationKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (LineTessellationKit const &in_kit) const
 
LineTessellationKitoperator= (LineTessellationKit &&in_that)
 
LineTessellationKitoperator= (LineTessellationKit const &in_kit)
 
bool operator== (LineTessellationKit const &in_kit) const
 
void Set (LineTessellationKit const &in_kit)
 
LineTessellationKitSetBCurveRenderingMethod (Line::BCurveRendering in_bcurve_rendering_method)
 
LineTessellationKitSetChordTolerance (double in_chord_tolerance, double in_maximum_chord_length, double in_maximum_chord_angle)
 
LineTessellationKitSetEdges (bool in_draw_edges, bool in_internal_edges)
 
LineTessellationKitSetHierarchicalOutput (Line::Hierarchical in_hierarchical_output)
 
LineTessellationKitSetIgnoreCriteria (bool in_ignore, Ignore in_ignore_criteria=Ignore::Absolute, double in_minimum_value=0)
 
LineTessellationKitSetMemoryLimit (bool in_use_memory_limit, size_t in_limit=0)
 
LineTessellationKitSetMissingGeometryFailure (bool in_fail_on_missing_geometry)
 
LineTessellationKitSetOverlappingBehavior (Line::OverlappingBehavior in_overlapping_behavior, IntArray in_indices_one=IntArray(), IntArray in_indices_two=IntArray())
 
LineTessellationKitSetParametricHatching (Line::Hatching::Parametric in_parametric_hatching, double in_u=0, double in_u_start=0, double in_v=0, double in_v_start=0)
 
LineTessellationKitSetPlanarHatching (Line::Hatching::Planar in_planar_haching, double in_planar_spacing=0, DPoint in_point_through=DPoint(0, 0, 0), DVector in_direction=DVector(0, 0, 0))
 
LineTessellationKitSetRadialHatching (Line::Hatching::Radial in_radial_hatching, double in_around=0, double in_around_start=0, double in_along=0, double in_along_start=0, double in_about=0, double in_about_start=0)
 
LineTessellationKitSetRegionalData (Line::Region in_region)
 
LineTessellationKitSetSilhouetteEdges (bool in_draw_silhouette_edges, bool in_draw_circles_as_arcs)
 
LineTessellationKitSetSmoothEdges (Line::Smooth in_smooth, double in_tolerance=0)
 
LineTessellationKitSetTransparentBodies (bool in_allow_transparency, bool in_transparent_hide, IntArray in_transparent_bodies=IntArray())
 
LineTessellationKitSetUnfixedBlends (Line::UnfixedBlends in_unfixed_blends, double in_spacing=0)
 
LineTessellationKitSetViewports (bool in_use_viewports, bool in_is_3d=true, bool viewport_clipping=false, ViewportArray in_viewports=ViewportArray())
 
LineTessellationKitSetVisibilityEvaluation (Line::Visibility in_visibility, bool in_draw_invisible=false, bool in_drafting=false, bool in_self_hidden=false, IntArray in_suppressed_indices=IntArray())
 
void Show (LineTessellationKit &out_kit) const
 
bool ShowBCurveRenderingMethod (Line::BCurveRendering &out_bcurve_rendering_method) const
 
bool ShowChordTolerance (double &out_chord_tolerance, double &out_maximum_chord_length, double &out_maximum_chord_angle) const
 
bool ShowEdges (bool &out_draw_edges, bool &out_internal_edges) const
 
bool ShowHierarchicalOutput (Line::Hierarchical &out_hierarchical_output) const
 
bool ShowIgnoreCriteria (bool &out_ignore, Ignore &out_ignore_criteria, double &out_minimum_value) const
 
bool ShowMemoryLimit (bool &out_use_memory_limit, size_t &out_limit) const
 
bool ShowMissingGeometryFailure (bool &out_fail_on_missing_geometry) const
 
bool ShowOverlappingBehavior (Line::OverlappingBehavior &out_overlapping_behavior, IntArray &out_indices_one, IntArray &out_indices_two) const
 
bool ShowParametericHatching (Line::Hatching::Parametric &out_parametric_hatching, double &out_u, double &out_u_start, double &out_v, double &out_v_start) const
 
bool ShowPlanarHatching (Line::Hatching::Planar &out_planar_haching, double &out_planar_spacing, DPoint &out_point_through, DVector &out_direction) const
 
bool ShowRadialHatching (Line::Hatching::Radial &out_radial_hatching, double &out_around, double &out_around_start, double &out_along, double &out_along_start, double &out_about, double &out_about_start) const
 
bool ShowRegionalData (Line::Region &out_region) const
 
bool ShowSilhouetteEdges (bool &out_draw_silhouette_edges, bool &out_draw_circles_as_arcs) const
 
bool ShowSmoothEdges (Line::Smooth &out_smooth, double &out_tolerance) const
 
bool ShowTransparentBodies (bool &out_allow_transparency, bool &out_transparent_hide, IntArray &out_force_transparent) const
 
bool ShowUnfixedBlends (Line::UnfixedBlends &out_unfixed_blends, double &out_spacing) const
 
bool ShowViewports (bool &out_use_viewports, bool &out_is_3d, bool &out_viewport_clipping, ViewportArray &out_viewports) const
 
bool ShowVisibilityEvaluation (Line::Visibility &out_visibility, bool &out_draw_invisible, bool &out_drafting, bool &out_self_hidden, IntArray &out_suppressed_indices) const
 
LineTessellationKitUnsetBCurveRenderingMethod ()
 
LineTessellationKitUnsetChordTolerance ()
 
LineTessellationKitUnsetEdges ()
 
LineTessellationKitUnsetEverything ()
 
LineTessellationKitUnsetHierarchicalOutput ()
 
LineTessellationKitUnsetIgnoreCriteria ()
 
LineTessellationKitUnsetMemoryLimit ()
 
LineTessellationKitUnsetMissingGeometryFailure ()
 
LineTessellationKitUnsetOverlappingBehavior ()
 
LineTessellationKitUnsetParametericHatching ()
 
LineTessellationKitUnsetPlanarHatching ()
 
LineTessellationKitUnsetRadialHatching ()
 
LineTessellationKitUnsetRegionalData ()
 
LineTessellationKitUnsetSilhouetteEdges ()
 
LineTessellationKitUnsetSmoothEdges ()
 
LineTessellationKitUnsetTransparentBodies ()
 
LineTessellationKitUnsetUnfixedBlends ()
 
LineTessellationKitUnsetViewports ()
 
LineTessellationKitUnsetVisibilityEvaluation ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static LineTessellationKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ParasolidLineTessellationKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

The LineTessellationKit class is a user space object. It contains settings controlling what and how data is imported via Parasolid.

Constructor & Destructor Documentation

◆ LineTessellationKit() [1/3]

HPS::Parasolid::LineTessellationKit::LineTessellationKit ( )

The default constructor creates an empty LineTessellationKit object.

◆ LineTessellationKit() [2/3]

HPS::Parasolid::LineTessellationKit::LineTessellationKit ( LineTessellationKit const &  in_kit)

The copy constructor creates a new LineTessellationKit object that contains the same settings as the source LineTessellationKit.

Parameters
in_kitThe source LineTessellationKit to copy.

◆ LineTessellationKit() [3/3]

HPS::Parasolid::LineTessellationKit::LineTessellationKit ( LineTessellationKit &&  in_that)

The move constructor creates an LineTessellationKit by transferring the underlying impl of the rvalue reference to this LineTessellationKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an LineTessellationKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::Parasolid::LineTessellationKit::Empty ( ) const
virtual

Indicates whether this LineTessellationKit has any values set on it.

Returns
true if no values are set on this LineTessellationKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Parasolid::LineTessellationKit::Equals ( LineTessellationKit const &  in_kit) const

Check if the source LineTessellationKit is equivalent to this LineTessellationKit.

Parameters
in_kitThe source LineTessellationKit to compare to this LineTessellationKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static LineTessellationKit HPS::Parasolid::LineTessellationKit::GetDefault ( )
static

Creates an LineTessellationKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File::Import.

Returns
An LineTessellationKit with the default settings.

◆ ObjectType()

HPS::Type HPS::Parasolid::LineTessellationKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Parasolid::LineTessellationKit::operator!= ( LineTessellationKit const &  in_kit) const

Check if the source LineTessellationKit is not equivalent to this LineTessellationKit.

Parameters
in_kitThe source LineTessellationKit to compare to this LineTessellationKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

LineTessellationKit& HPS::Parasolid::LineTessellationKit::operator= ( LineTessellationKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this LineTessellationKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an LineTessellationKit to take the impl from.
Returns
A reference to this LineTessellationKit.

◆ operator=() [2/2]

LineTessellationKit& HPS::Parasolid::LineTessellationKit::operator= ( LineTessellationKit const &  in_kit)

Copies the source LineTessellationKit into this LineTessellationKit.

Parameters
in_kitThe source LineTessellationKit to copy.
Returns
A reference to this LineTessellationKit.

◆ operator==()

bool HPS::Parasolid::LineTessellationKit::operator== ( LineTessellationKit const &  in_kit) const

Check if the source LineTessellationKit is equivalent to this LineTessellationKit.

Parameters
in_kitThe source LineTessellationKit to compare to this LineTessellationKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Parasolid::LineTessellationKit::Set ( LineTessellationKit const &  in_kit)

Copies the source LineTessellationKit into this LineTessellationKit.

Parameters
in_kitThe source LineTessellationKit to copy.

◆ SetBCurveRenderingMethod()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetBCurveRenderingMethod ( Line::BCurveRendering  in_bcurve_rendering_method)

Sets the method used to render bcurves

Parameters
in_bcurve_rendering_methodthe method used to render bcurves. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.bcurve.
Returns
A reference to this LineTessellationKit.

◆ SetChordTolerance()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetChordTolerance ( double  in_chord_tolerance,
double  in_maximum_chord_length,
double  in_maximum_chord_angle 
)

Sets chord tolerance.

Parameters
in_chord_tolerancecurve chordal tolerance between a curve and chord edges. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.curve_chord_tol.
in_maximum_chord_lengthmaximum chord length. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.curve_chord_max.
in_maximum_chord_anglemaximum chord angle, in radians. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.curve_chord_ang.
Returns
A reference to this LineTessellationKit.

◆ SetEdges()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetEdges ( bool  in_draw_edges,
bool  in_internal_edges 
)

Sets whether edges are drawn.

Parameters
in_draw_edgeswhether edges are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.edge.
in_internal_edgeswhether edges are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.internal.
Returns
A reference to this LineTessellationKit.

◆ SetHierarchicalOutput()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetHierarchicalOutput ( Line::Hierarchical  in_hierarchical_output)

Sets whether a hierarchical output is produced

Parameters
in_hierarchical_outputwhether a hierarchical output is produced. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.hierarch.
Returns
A reference to this LineTessellationKit.

◆ SetIgnoreCriteria()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetIgnoreCriteria ( bool  in_ignore,
Ignore  in_ignore_criteria = Ignore::Absolute,
double  in_minimum_value = 0 
)

Sets criteria for ignoring lines.

Parameters
in_ignorewhether any line should be ignored.
in_ignore_criteriaspecifies how to interpret the minimum_value parameter. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.ignore.
in_minimum_valueminimum value for a facet not to be ignored. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.ignore_value.
Returns
A reference to this LineTessellationKit.

◆ SetMemoryLimit()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetMemoryLimit ( bool  in_use_memory_limit,
size_t  in_limit = 0 
)

Sets whether a memory limit should be used for rendering lines

Parameters
in_use_memory_limitwhether a memory limit should be used for rendering lines. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.memory_target.
in_limitthe memory limits, in bytes. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.memory_target_value.
Returns
A reference to this LineTessellationKit.

◆ SetMissingGeometryFailure()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetMissingGeometryFailure ( bool  in_fail_on_missing_geometry)

Sets the behavior the import assumes when it encounters missing geometry

Parameters
in_fail_on_missing_geometrywhether the importer should fail when encountering missing geometry. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.ske_missing.
Returns
A reference to this LineTessellationKit.

◆ SetOverlappingBehavior()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetOverlappingBehavior ( Line::OverlappingBehavior  in_overlapping_behavior,
IntArray  in_indices_one = IntArray(),
IntArray  in_indices_two = IntArray() 
)

Sets the behavior the import assumes when it encounters overlapping curves

Parameters
in_overlapping_behaviorthe behavior the import assumes when it encounters overlapping curves. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.overlap.
in_indices_onearray of body occurrences used for clashing. Only relevant if in_overlapping_behavior equals AllowAndIntersectAll or AllowAndIntersectPairs. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.overlap_indices1.
in_indices_twoarray of body occurrences used for clashing. Only relevant if in_overlapping_behavior equals AllowAndIntersectAll or AllowAndIntersectPairs. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.overlap_indices2.
Returns
A reference to this LineTessellationKit.

◆ SetParametricHatching()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetParametricHatching ( Line::Hatching::Parametric  in_parametric_hatching,
double  in_u = 0,
double  in_u_start = 0,
double  in_v = 0,
double  in_v_start = 0 
)

Sets parametric hatching tessellation options

Parameters
in_parametric_hatchingthe type of parametric hatching desired. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param.
in_uhatch spacing in u direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_u. Only relevant if in_parametric_hatching equals to either ByVectorNoLocking or ByVector
in_u_startstart value for parametric hatching in the u direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_u_start. Only relevant if in_planar_hatching equals to either ByVectorNoLocking or ByVector
in_vhatch spacing in v direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_v. Only relevant if in_parametric_hatching equals to either ByVectorNoLocking or ByVector
in_v_startstart value for parametric hatching in the v direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_v_start. Only relevant if in_planar_hatching equals to either ByVectorNoLocking or ByVector
Returns
A reference to this LineTessellationKit.

◆ SetPlanarHatching()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetPlanarHatching ( Line::Hatching::Planar  in_planar_haching,
double  in_planar_spacing = 0,
DPoint  in_point_through = DPoint(0, 0, 0),
DVector  in_direction = DVector(0, 0, 0) 
)

Sets planar hatching tessellation options

Parameters
in_planar_hachingthe type of planar hatching desired. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.planar.
in_planar_spacingdistance between panes. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.planar_spacing.
in_point_throughused with in_direction to determine the axis for planar hatching. Only relevant if in_planar_hatching equals to either ByVectorNoLocking or ByVector
in_directionused with in_point_through to determine the axis for planar hatching. Only relevant if in_planar_hatching equals to either ByVectorNoLocking or ByVector
Returns
A reference to this LineTessellationKit.

◆ SetRadialHatching()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetRadialHatching ( Line::Hatching::Radial  in_radial_hatching,
double  in_around = 0,
double  in_around_start = 0,
double  in_along = 0,
double  in_along_start = 0,
double  in_about = 0,
double  in_about_start = 0 
)

Sets radial hatching tessellation options

Parameters
in_radial_hatchingthe type of radial hatching desired. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial.
in_aroundangular spacing around spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_around. Only relevant if in_radial_hatching equals to either ByVectorNoLocking or ByVector
in_around_startstarting value for angular spacing around spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_around_start. Only relevant if in_radial_hatching equals to either ByVectorNoLocking or ByVector
in_alongspacing along spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_along. Only relevant if in_radial_hatching equals to either ByVectorNoLocking or ByVector
in_along_startstarting value for angular spacing along spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_along_start. Only relevant if in_radial_hatching equals to either ByVectorNoLocking or ByVector
in_aboutspacing about spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_about. Only relevant if in_radial_hatching equals to either ByVectorNoLocking or ByVector
in_about_startstarting value for angular spacing about spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_about_start. Only relevant if in_radial_hatching equals to either ByVectorNoLocking or ByVector
Returns
A reference to this LineTessellationKit.

◆ SetRegionalData()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetRegionalData ( Line::Region  in_region)

Sets whether regional data is produced.

Parameters
in_regionwhether regional data is produced. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.region.
Returns
A reference to this LineTessellationKit.

◆ SetSilhouetteEdges()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetSilhouetteEdges ( bool  in_draw_silhouette_edges,
bool  in_draw_circles_as_arcs 
)

Sets whether silhouette edges are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.silhouette.

Parameters
in_draw_silhouette_edgeswhether silhouette edges are drawn.
in_draw_circles_as_arcswhether near circular analytic silhouettes can be drawn as arcs
Returns
A reference to this LineTessellationKit.

◆ SetSmoothEdges()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetSmoothEdges ( Line::Smooth  in_smooth,
double  in_tolerance = 0 
)

Sets whether to indicate smooth edges

Parameters
in_smoothwhether to indicate smooth edges. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.smooth.
in_tolerancemaximum angle allowed between faces for edges to be smooth. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.edge_smooth_tol.
Returns
A reference to this LineTessellationKit.

◆ SetTransparentBodies()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetTransparentBodies ( bool  in_allow_transparency,
bool  in_transparent_hide,
IntArray  in_transparent_bodies = IntArray() 
)

Sets the transparency settings for line tessellation

Parameters
in_allow_transparencywhether transparent bodies are drawn. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.transparent.
in_transparent_hidewhether transparent bodies can hide other transparent bodies. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.transparent_hid.
in_transparent_bodiesan array of body occurrences to be rendered transparent. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.transparent_indices.
Returns
A reference to this LineTessellationKit.

◆ SetUnfixedBlends()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetUnfixedBlends ( Line::UnfixedBlends  in_unfixed_blends,
double  in_spacing = 0 
)

Sets whether unfixed blends are drawn

Parameters
in_unfixed_blendswhether unfixed blends are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.unfix.
in_spacingdefault rib spacing. Only relevant if in_unfixed_blends equals Draw. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.unfix_spacing.
Returns
A reference to this LineTessellationKit.

◆ SetViewports()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetViewports ( bool  in_use_viewports,
bool  in_is_3d = true,
bool  viewport_clipping = false,
ViewportArray  in_viewports = ViewportArray() 
)

Sets whether the importer uses viewports and how.

Parameters
in_use_viewportswhether the importer uses viewports. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.viewport
in_is_3dwhether the viewports used are three dimensional or not. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.viewport_type.
viewport_clippingwhether viewport clipping should be used. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.viewport_clipping.
in_viewportsthe viewports used.
Returns
A reference to this LineTessellationKit.

◆ SetVisibilityEvaluation()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::SetVisibilityEvaluation ( Line::Visibility  in_visibility,
bool  in_draw_invisible = false,
bool  in_drafting = false,
bool  in_self_hidden = false,
IntArray  in_suppressed_indices = IntArray() 
)

Sets whether visibility is evaluated

Parameters
in_visibilitysetting for visibility evaluation. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.visibility.
in_draw_invisiblewhether to output invisible lines. Only relevant if in_visibility equals Custom. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.invisible.
in_draftingwhether to distinguish between lines hidden by other lines and lines hidden by faces. Only relevant if in_visibility equals Custom. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.drafting.
in_self_hiddenwhether to distinguish lines that are self-hidden or hidden by another occurrence of themselves. Only relevant if in_visibility equals Custom. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.self_hidden.
in_suppressed_indicesarray of indices for which invisible lines are suppressed. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.suppressed_indices.
Returns
A reference to this LineTessellationKit.

◆ Show()

void HPS::Parasolid::LineTessellationKit::Show ( LineTessellationKit out_kit) const

Copies this LineTessellationKit into the given LineTessellationKit.

Parameters
out_kitThe LineTessellationKit to populate with the contents of this LineTessellationKit.

◆ ShowBCurveRenderingMethod()

bool HPS::Parasolid::LineTessellationKit::ShowBCurveRenderingMethod ( Line::BCurveRendering out_bcurve_rendering_method) const

Shows the method used to render bcurves

Parameters
&out_bcurve_rendering_method the method used to render bcurves. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.bcurve.
Returns
true if a bcurve setting was specified, false otherwise.

◆ ShowChordTolerance()

bool HPS::Parasolid::LineTessellationKit::ShowChordTolerance ( double &  out_chord_tolerance,
double &  out_maximum_chord_length,
double &  out_maximum_chord_angle 
) const

Shows chord tolerance.

Parameters
&out_chord_tolerance curve chordal tolerance between a curve and chord edges. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.curve_chord_tol.
&out_maximum_chord_length maximum chord length. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.curve_chord_max.
&out_maximum_chord_angle maximum chord angle, in radians. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.curve_chord_ang.
Returns
true if a tolerance setting was specified, false otherwise.

◆ ShowEdges()

bool HPS::Parasolid::LineTessellationKit::ShowEdges ( bool &  out_draw_edges,
bool &  out_internal_edges 
) const

Shows whether edges are drawn.

Parameters
&out_draw_edges whether edges are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.edge.
&out_internal_edges whether edges are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.internal.
Returns
true if an edge setting was specified, false otherwise.

◆ ShowHierarchicalOutput()

bool HPS::Parasolid::LineTessellationKit::ShowHierarchicalOutput ( Line::Hierarchical out_hierarchical_output) const

Shows whether a hierarchical output is produced

Parameters
&out_hierarchical_output whether a hierarchical output is produced. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.hierarch.
Returns
true if a hierarchical setting was specified, false otherwise.

◆ ShowIgnoreCriteria()

bool HPS::Parasolid::LineTessellationKit::ShowIgnoreCriteria ( bool &  out_ignore,
Ignore out_ignore_criteria,
double &  out_minimum_value 
) const

Shows criteria for ignoring lines.

Parameters
&out_ignore whether any line should be ignored.
&out_ignore_criteria specifies how to interpret the minimum_value parameter. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.ignore.
&out_minimum_value minimum value for a facet not to be ignored. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.ignore_value.
Returns
true if an ignore criteria setting was specified, false otherwise.

◆ ShowMemoryLimit()

bool HPS::Parasolid::LineTessellationKit::ShowMemoryLimit ( bool &  out_use_memory_limit,
size_t &  out_limit 
) const

Shows whether a memory limit should be used for rendering lines

Parameters
&out_use_memory_limit whether a memory limit should be used for rendering lines. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.memory_target.
&out_limit the memory limits, in bytes. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.memory_target_value.
Returns
true if an memory limit setting was specified, false otherwise.

◆ ShowMissingGeometryFailure()

bool HPS::Parasolid::LineTessellationKit::ShowMissingGeometryFailure ( bool &  out_fail_on_missing_geometry) const

Shows the behavior the import assumes when it encounters missing geometry

Parameters
&out_fail_on_missing_geometry whether the importer should fail when encountering missing geometry. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.ske_missing.
Returns
true if a missing geometry setting was specified, false otherwise.

◆ ShowOverlappingBehavior()

bool HPS::Parasolid::LineTessellationKit::ShowOverlappingBehavior ( Line::OverlappingBehavior out_overlapping_behavior,
IntArray out_indices_one,
IntArray out_indices_two 
) const

Shows the behavior the import assumes when it encounters overlapping curves

Parameters
&out_overlapping_behavior the behavior the import assumes when it encounters overlapping curves. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.overlap.
&out_indices_one array of body occurrences used for clashing. Only relevant if & out_overlapping_behavior equals AllowAndIntersectAll or AllowAndIntersectPairs. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.overlap_indices1.
&out_indices_two array of body occurrences used for clashing. Only relevant if & out_overlapping_behavior equals AllowAndIntersectAll or AllowAndIntersectPairs. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.overlap_indices2.
Returns
true if an overlapping behavior setting was specified, false otherwise.

◆ ShowParametericHatching()

bool HPS::Parasolid::LineTessellationKit::ShowParametericHatching ( Line::Hatching::Parametric out_parametric_hatching,
double &  out_u,
double &  out_u_start,
double &  out_v,
double &  out_v_start 
) const

Shows parametric hatching tessellation options

Parameters
&out_parametric_hatching the type of parametric hatching desired. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param.
&out_u hatch spacing in u direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_u. Only relevant if & out_parametric_hatching equals to either ByVectorNoLocking or ByVector
&out_u_start start value for parametric hatching in the u direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_u_start. Only relevant if & out_planar_hatching equals to either ByVectorNoLocking or ByVector
&out_v hatch spacing in v direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_v. Only relevant if & out_parametric_hatching equals to either ByVectorNoLocking or ByVector
&out_v_start start value for parametric hatching in the v direction. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.param_v_start. Only relevant if & out_planar_hatching equals to either ByVectorNoLocking or ByVector
Returns
true if a parametric hatching setting was specified, false otherwise.

◆ ShowPlanarHatching()

bool HPS::Parasolid::LineTessellationKit::ShowPlanarHatching ( Line::Hatching::Planar out_planar_haching,
double &  out_planar_spacing,
DPoint out_point_through,
DVector out_direction 
) const

Shows planar hatching tessellation options

Parameters
&out_planar_haching the type of planar hatching desired. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.planar.
&out_planar_spacing distance between panes. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.planar_spacing.
&out_point_through used with & out_direction to determine the axis for planar hatching. Only relevant if & out_planar_hatching equals to either ByVectorNoLocking or ByVector
&out_direction used with & out_point_through to determine the axis for planar hatching. Only relevant if & out_planar_hatching equals to either ByVectorNoLocking or ByVector
Returns
true if a planar hatching setting was specified, false otherwise.

◆ ShowRadialHatching()

bool HPS::Parasolid::LineTessellationKit::ShowRadialHatching ( Line::Hatching::Radial out_radial_hatching,
double &  out_around,
double &  out_around_start,
double &  out_along,
double &  out_along_start,
double &  out_about,
double &  out_about_start 
) const

Shows radial hatching tessellation options

Parameters
&out_radial_hatching the type of radial hatching desired. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial.
&out_around angular spacing around spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_around. Only relevant if & out_radial_hatching equals to either ByVectorNoLocking or ByVector
&out_around_start starting value for angular spacing around spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_around_start. Only relevant if & out_radial_hatching equals to either ByVectorNoLocking or ByVector
&out_along spacing along spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_along. Only relevant if & out_radial_hatching equals to either ByVectorNoLocking or ByVector
&out_along_start starting value for angular spacing along spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_along_start. Only relevant if & out_radial_hatching equals to either ByVectorNoLocking or ByVector
&out_about spacing about spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_about. Only relevant if & out_radial_hatching equals to either ByVectorNoLocking or ByVector
&out_about_start starting value for angular spacing about spine. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.radial_about_start. Only relevant if & out_radial_hatching equals to either ByVectorNoLocking or ByVector
Returns
true if a radial hatching setting was specified, false otherwise.

◆ ShowRegionalData()

bool HPS::Parasolid::LineTessellationKit::ShowRegionalData ( Line::Region out_region) const

Shows whether regional data is produced.

Parameters
&out_region whether regional data is produced. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.region.
Returns
true if a region setting was specified, false otherwise.

◆ ShowSilhouetteEdges()

bool HPS::Parasolid::LineTessellationKit::ShowSilhouetteEdges ( bool &  out_draw_silhouette_edges,
bool &  out_draw_circles_as_arcs 
) const

Shows whether silhouette edges are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.silhouette.

Parameters
&out_draw_silhouette_edges whether silhouette edges are drawn.
&out_draw_circles_as_arcs whether near circular analytic silhouettes can be drawn as arcs
Returns
true if a silhouette edges setting was specified, false otherwise.

◆ ShowSmoothEdges()

bool HPS::Parasolid::LineTessellationKit::ShowSmoothEdges ( Line::Smooth out_smooth,
double &  out_tolerance 
) const

Shows whether to indicate smooth edges

Parameters
&out_smooth whether to indicate smooth edges. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.smooth.
&out_tolerance maximum angle allowed between faces for edges to be smooth. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.edge_smooth_tol.
Returns
true if a smooth edge setting was specified, false otherwise.

◆ ShowTransparentBodies()

bool HPS::Parasolid::LineTessellationKit::ShowTransparentBodies ( bool &  out_allow_transparency,
bool &  out_transparent_hide,
IntArray out_force_transparent 
) const

Shows the transparency setting for line tessellation

Parameters
&out_allow_transparency whether transparent bodies are drawn. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.transparent.
&out_transparent_hide whether transparent bodies can hide other transparent bodies. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.transparent_hid.
&out_force_transparent an array of body occurrences to be rendered transparent. Corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.transparent_indices.
Returns
true if a transparency setting was specified, false otherwise.

◆ ShowUnfixedBlends()

bool HPS::Parasolid::LineTessellationKit::ShowUnfixedBlends ( Line::UnfixedBlends out_unfixed_blends,
double &  out_spacing 
) const

Shows whether unfixed blends are drawn

Parameters
&out_unfixed_blends whether unfixed blends are drawn. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.unfix.
&out_spacing default rib spacing. Only relevant if & out_unfixed_blends equals ByAttribute. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.unfix_spacing.
Returns
true if an unfixed blends setting was specified, false otherwise.

◆ ShowViewports()

bool HPS::Parasolid::LineTessellationKit::ShowViewports ( bool &  out_use_viewports,
bool &  out_is_3d,
bool &  out_viewport_clipping,
ViewportArray &  out_viewports 
) const

Shows whether the importer uses viewports and how.

Parameters
&out_use_viewports whether the importer uses viewports. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.viewport
&out_is_3d whether the viewports used are three dimensional or not. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.viewport_type.
viewport_clippingwhether viewport clipping should be used. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.viewport_clipping.
&out_viewports the viewports used.
Returns
true if a viewport setting was specified, false otherwise.

◆ ShowVisibilityEvaluation()

bool HPS::Parasolid::LineTessellationKit::ShowVisibilityEvaluation ( Line::Visibility out_visibility,
bool &  out_draw_invisible,
bool &  out_drafting,
bool &  out_self_hidden,
IntArray out_suppressed_indices 
) const

Shows whether visibility is evaluated

Parameters
&out_visibility Setting for visibility evaluation. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.visibility.
&out_draw_invisible whether to output invisible lines. Only relevant if & out_visibility equals Custom. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.invisible.
&out_drafting whether to distinguish between lines hidden by other lines and lines hidden by faces. Only relevant if & out_visibility equals Custom. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.drafting.
&out_self_hidden whether to distinguish lines that are self-hidden or hidden by another occurrence of themselves. Only relevant if & out_visibility equals Custom. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.self_hidden.
&out_suppressed_indices array of indices for which invisible lines are suppressed. This corresponds to the value that will be passed to PK_TOPOL_render_line_o_t.suppressed_indices.
Returns
true if a visibility setting was specified, false otherwise.

◆ UnsetBCurveRenderingMethod()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetBCurveRenderingMethod ( )

Removes the bcurve rendering method tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetChordTolerance()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetChordTolerance ( )

Removes the chord tolerance tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetEdges()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetEdges ( )

Removes the edge tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetEverything()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetEverything ( )

Removes all settings from this LineTessellationKit.

Returns
A reference to this LineTessellationKit.

◆ UnsetHierarchicalOutput()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetHierarchicalOutput ( )

Removes the hierarchical output tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetIgnoreCriteria()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetIgnoreCriteria ( )

Removes the ignore criteria tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetMemoryLimit()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetMemoryLimit ( )

Removes the memory limit tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetMissingGeometryFailure()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetMissingGeometryFailure ( )

Removes the missing geometry tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetOverlappingBehavior()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetOverlappingBehavior ( )

Removes the overlapping geometry tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetParametericHatching()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetParametericHatching ( )

Removes the parametric hatching tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetPlanarHatching()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetPlanarHatching ( )

Removes the planar hatching tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetRadialHatching()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetRadialHatching ( )

Removes the radial hatching tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetRegionalData()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetRegionalData ( )

Removes the regional data tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetSilhouetteEdges()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetSilhouetteEdges ( )

Removes the silhouette edges tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetSmoothEdges()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetSmoothEdges ( )

Removes the smooth edges tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetTransparentBodies()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetTransparentBodies ( )

Removes the transparent bodies tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetUnfixedBlends()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetUnfixedBlends ( )

Removes the unfixed blends tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetViewports()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetViewports ( )

Removes the viewports tessellation state.

Returns
A reference to this LineTessellationKit.

◆ UnsetVisibilityEvaluation()

LineTessellationKit& HPS::Parasolid::LineTessellationKit::UnsetVisibilityEvaluation ( )

Removes the visibility evaluation tessellation state.

Returns
A reference to this LineTessellationKit.

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