< Home

< Table of Contents

REFERENCE MANUAL

HPS.Sketchup.ImportOptionsKit Class Reference

The ImportOptionsKit class is a user space object. More...

Inheritance diagram for HPS.Sketchup.ImportOptionsKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ImportOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Sketchup.ImportOptionsKit in_kit)
 Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 The default constructor creates an empty ImportOptionsKit object. More...
 
 ImportOptionsKit (HPS.Sketchup.ImportOptionsKit in_kit)
 The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Sketchup.ImportOptionsKit in_kit)
 Copies the source ImportOptionsKit into this ImportOptionsKit. More...
 
HPS.Sketchup.ImportOptionsKit SetHiddenData (bool in_state)
 Sets whether to import hidden data from the SketchUp file. More...
 
HPS.Sketchup.ImportOptionsKit SetMetaData (bool in_state)
 Sets whether to import metadata from the SketchUp file. More...
 
HPS.Sketchup.ImportOptionsKit SetPortfolio (HPS.PortfolioKey in_portfolio)
 Sets the PortfolioKey where the SketchUp data will be imported into. More...
 
HPS.Sketchup.ImportOptionsKit SetTarget (HPS.SegmentKey in_target, HPS.SegmentKey in_library)
 Sets the root and library segments where the SketchUp data will be imported into. More...
 
HPS.Sketchup.ImportOptionsKit SetTarget (HPS.Model in_model)
 Uses the Model to set the root segment, library segment, and portfolio where the SketchUp data will be imported into. More...
 
HPS.Sketchup.ImportOptionsKit SetView (HPS.View in_view)
 Sets the View where the default SketchUp camera will be imported into. More...
 
void Show (out HPS.Sketchup.ImportOptionsKit out_kit)
 Copies this ImportOptionsKit into the given ImportOptionsKit. More...
 
bool ShowHiddenData (out bool out_state)
 Shows whether to import hidden data from the SketchUp file. More...
 
bool ShowMetaData (out bool out_state)
 Shows whether to import metadata from the SketchUp file. More...
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 Shows the PortfolioKey where the SketchUp data will be imported into. More...
 
bool ShowTarget (out HPS.SegmentKey out_target, out HPS.SegmentKey out_library)
 Shows the root and library segments where the SketchUp data will be imported into. More...
 
bool ShowTarget (out HPS.Model out_model)
 Shows the root and library segments and portfolio where the SketchUp data will be imported into. More...
 
bool ShowView (out HPS.View out_view)
 Shows the view where the SketchUp camera will be imported into. More...
 
HPS.Sketchup.ImportOptionsKit UnsetEverything ()
 Removes all settings from this ImportOptionsKit. More...
 
HPS.Sketchup.ImportOptionsKit UnsetHiddenData ()
 Removes the Hidden data import state. More...
 
HPS.Sketchup.ImportOptionsKit UnsetMetaData ()
 Removes the metadata import state. More...
 
HPS.Sketchup.ImportOptionsKit UnsetPortfolio ()
 Removes the Portfolio import state. More...
 
HPS.Sketchup.ImportOptionsKit UnsetTarget ()
 Removes the target and library segments, and Model import state. More...
 
HPS.Sketchup.ImportOptionsKit UnsetView ()
 Removes the View import state. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static
HPS.Sketchup.ImportOptionsKit 
GetDefault ()
 Creates an ImportOptionsKit which contains the default settings. More...
 
static bool operator!= (HPS.Sketchup.ImportOptionsKit a, HPS.Sketchup.ImportOptionsKit b)
 
static bool operator== (HPS.Sketchup.ImportOptionsKit a, HPS.Sketchup.ImportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ImportOptionsKit class is a user space object.

It contains settings controlling what and how data is imported via Sketchup.

Constructor & Destructor Documentation

HPS.Sketchup.ImportOptionsKit.ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

HPS.Sketchup.ImportOptionsKit.ImportOptionsKit ( HPS.Sketchup.ImportOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.Sketchup.ImportOptionsKit.Empty ( )
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.Sketchup.ImportOptionsKit.Equals ( HPS.Sketchup.ImportOptionsKit  in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_sketchup_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.GetDefault ( )
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.
override HPS.Type HPS.Sketchup.ImportOptionsKit.ObjectType ( )
virtual

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.Object.

void HPS.Sketchup.ImportOptionsKit.Set ( HPS.Sketchup.ImportOptionsKit  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetHiddenData ( bool  in_state)

Sets whether to import hidden data from the SketchUp file.

Defaults to false.

Parameters
in_stateWhether to import hidden data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetMetaData ( bool  in_state)

Sets whether to import metadata from the SketchUp file.

Defaults to false.

Parameters
in_stateWhether to import metadata data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetPortfolio ( HPS.PortfolioKey  in_portfolio)

Sets the PortfolioKey where the SketchUp data will be imported into.

If no segments are specified, root segments will be created for this purpose during import.

Parameters
in_portfolioPortfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetTarget ( HPS.SegmentKey  in_target,
HPS.SegmentKey  in_library 
)

Sets the root and library segments where the SketchUp data will be imported into.

If no segments are specified, root segments will be created for this purpose during import.

Parameters
in_targetSegment the SketchUp data will be imported into.
in_librarySegment the SketchUp includes data will be imported into.
Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetTarget ( HPS.Model  in_model)

Uses the Model to set the root segment, library segment, and portfolio where the SketchUp data will be imported into.

Parameters
in_modelModel to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetView ( HPS.View  in_view)

Sets the View where the default SketchUp camera will be imported into.

If no View provided, camera can be retrieved via ImportResultsKit::ShowMainCamera.

Parameters
in_viewView where SketchUp camera will be imported into.
Returns
A reference to this ImportOptionsKit.
void HPS.Sketchup.ImportOptionsKit.Show ( out HPS.Sketchup.ImportOptionsKit  out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_sketchup_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_sketchup_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>.
bool HPS.Sketchup.ImportOptionsKit.ShowHiddenData ( out bool  out_state)

Shows whether to import hidden data from the SketchUp file.

Defaults to false.

Parameters
out_stateWhether to import hidden data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.
bool HPS.Sketchup.ImportOptionsKit.ShowMetaData ( out bool  out_state)

Shows whether to import metadata from the SketchUp file.

Defaults to false.

Parameters
out_stateWhether to import metadata data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.
bool HPS.Sketchup.ImportOptionsKit.ShowPortfolio ( out HPS.PortfolioKey  out_portfolio)

Shows the PortfolioKey where the SketchUp data will be imported into.

If no segments are specified, root segments will be created for this purpose during import.

Parameters
out_portfolioPortfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.
bool HPS.Sketchup.ImportOptionsKit.ShowTarget ( out HPS.SegmentKey  out_target,
out HPS.SegmentKey  out_library 
)

Shows the root and library segments where the SketchUp data will be imported into.

If no segments are specified, root segments will be created for this purpose during import.

Parameters
out_targetSegment the SketchUp data will be imported into.
out_librarySegment the SketchUp includes data will be imported into.
Returns
A reference to this ImportOptionsKit.
bool HPS.Sketchup.ImportOptionsKit.ShowTarget ( out HPS.Model  out_model)

Shows the root and library segments and portfolio where the SketchUp data will be imported into.

If no segments are specified, root segments will be created for this purpose during import.

Parameters
out_modelModel to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.
bool HPS.Sketchup.ImportOptionsKit.ShowView ( out HPS.View  out_view)

Shows the view where the SketchUp camera will be imported into.

Parameters
out_viewView where SketchUp camera will be imported into.
Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetHiddenData ( )

Removes the Hidden data import state.

Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetMetaData ( )

Removes the metadata import state.

Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetPortfolio ( )

Removes the Portfolio import state.

Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetTarget ( )

Removes the target and library segments, and Model import state.

Returns
A reference to this ImportOptionsKit.
HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetView ( )

Removes the View import state.

Returns
A reference to this ImportOptionsKit.

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