#include <sprk_parasolid.h>

Static Public Member Functions | |
static ImportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via the Parasolid interface. Calling HPS::Parasolid::ImportOptionsKit::GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
HPS::Parasolid::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
HPS::Parasolid::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
HPS::Parasolid::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit && | in_that | ) |
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
Member Function Documentation
|
virtual |
Indicates whether this ImportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ImportOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::Parasolid::ImportOptionsKit::Equals | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
Creates an ImportOptionsKit 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 ImportOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::SprocketKit.
bool HPS::Parasolid::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::operator= | ( | ImportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
- Returns
- A reference to this ImportOptionsKit.
bool HPS::Parasolid::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::Parasolid::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetAttributeMismatchBehavior | ( | Parasolid::MismatchBehavior | in_behavior | ) |
Sets the importer behavior for mismatched attributes. This corresponds to the value that will be passed to PK_PART_receive_o_t.attdef_mismatch.
- Parameters
-
in_behavior The behavior of the importer when mismatched attributes are found.
- Returns
- A reference to this ImportOptionsKit.
- See also
- Default value
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetCompoundBodyBehavior | ( | Parasolid::CompoundBodyBehavior | in_behavior | ) |
Sets the importer behavior for compound bodies. This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_compound.
- Parameters
-
in_behavior The behavior of the importer when compound bodies are found.
- Returns
- A reference to this ImportOptionsKit.
- See also
- Default value
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetFacetTessellation | ( | Parasolid::FacetTessellationKit const & | in_facet_tessellation_kit | ) |
Sets the facet tessellation settings used during import This corresponds to the PK_TOPOL_render_facet_o_t struct.
- Parameters
-
in_facet_tessellation_kit The facet tessellation settings used during import
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetFormat | ( | Parasolid::Format | in_format | ) |
Sets the format type to be imported. This corresponds to the value that will be passed to PK_PART_receive_o_t.transmit_format.
- Parameters
-
in_format The format of the file to be imported.
- Returns
- A reference to this ImportOptionsKit.
- See also
- Default value
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetLineTessellation | ( | Parasolid::LineTessellationKit const & | in_line_tessellation_kit | ) |
Sets the line tessellation settings used during import This corresponds to the PK_TOPOL_render_line_o_t struct.
- Parameters
-
in_facet_tessellation_kit The line tessellation settings used during import
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetUserFields | ( | bool | in_import_user_fields | ) |
Sets whether to import user fields from the CAD file. This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_user_fields.
- Parameters
-
in_import_user_fields Whether to import user fields from the CAD file.
- Returns
- A reference to this ImportOptionsKit.
- See also
- Default value
void HPS::Parasolid::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
bool HPS::Parasolid::ImportOptionsKit::ShowAttributeMismatchBehavior | ( | Parasolid::MismatchBehavior & | out_behavior | ) | const |
Shows the attribute mismatch behavior import setting.
- Parameters
-
out_behavior The attribute mismatch behavior setting for this import.
- Returns
- true if an attribute mismatch behavior setting was specified, false otherwise.
bool HPS::Parasolid::ImportOptionsKit::ShowCompoundBodyBehavior | ( | Parasolid::CompoundBodyBehavior & | out_behavior | ) | const |
Shows the compound body behavior import setting.
- Parameters
-
out_behavior The compound body behavior setting for this import.
- Returns
- true if a compound body behavior setting was specified, false otherwise.
bool HPS::Parasolid::ImportOptionsKit::ShowFacetTessellation | ( | Parasolid::FacetTessellationKit & | out_facet_tessellation | ) | const |
Shows the facet tessellation import setting.
- Parameters
-
out_facet_tessellation The facet tessellation setting for this import.
- Returns
- true if a facet tessellation setting was specified, false otherwise.
bool HPS::Parasolid::ImportOptionsKit::ShowFormat | ( | Parasolid::Format & | out_format | ) | const |
Shows the format import setting.
- Parameters
-
out_format The format setting for this import.
- Returns
- true if a format setting was specified, false otherwise.
bool HPS::Parasolid::ImportOptionsKit::ShowLineTessellation | ( | Parasolid::LineTessellationKit & | out_line_tessellation | ) | const |
Shows the line tessellation import setting.
- Parameters
-
out_line_tessellation The line tessellation setting for this import.
- Returns
- true if a line tessellation setting was specified, false otherwise.
bool HPS::Parasolid::ImportOptionsKit::ShowUserFields | ( | bool & | out_user_fields | ) | const |
Shows the user fields import setting.
- Parameters
-
out_user_fields The user fields setting for this import.
- Returns
- true if a user fields setting was specified, false otherwise.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetAttributeMismatchBehavior | ( | ) |
Removes the attribute mismatch behavior state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetCompoundBodyBehavior | ( | ) |
Removes the compound body behavior state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetFacetTessellation | ( | ) |
Removes the facet tessellation state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetFormat | ( | ) |
Removes the format import state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetLineTessellation | ( | ) |
Removes the line tessellation state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetUserFields | ( | ) |
Removes the user fields import state.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_parasolid.h