< Home

< Table of Contents

REFERENCE MANUAL

HPS.Sketchup.ImportResultsKit Class Reference

The ImportResultsKit class contains the results of a successful SketchUp import. More...

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ImportResultsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Sketchup.ImportResultsKit in_kit)
 Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...
 
override int GetHashCode ()
 
 ImportResultsKit ()
 The default constructor creates an empty ImportResultsKit object. More...
 
 ImportResultsKit (HPS.Sketchup.ImportResultsKit in_kit)
 The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Sketchup.ImportResultsKit in_kit)
 Copies the source ImportResultsKit into this ImportResultsKit. More...
 
void Show (out HPS.Sketchup.ImportResultsKit out_kit)
 Copies this ImportResultsKit into the given ImportResultsKit. More...
 
bool ShowMainCamera (out HPS.CameraKit out_camera)
 Shows the camera where the main SketchUp camera was imported into. More...
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 Shows the PortfolioKey where the SketchUp data was imported into. More...
 
bool ShowScenes (out string[] out_names, out HPS.CameraKit[] out_cameras)
 Shows the scenes imported from SketchUp. More...
 
bool ShowTarget (out HPS.SegmentKey out_target, out HPS.SegmentKey out_library)
 Shows the root and library segments where the SketchUp data was imported into. More...
 
bool ShowTarget (out HPS.Model out_model)
 Shows the Model where the SketchUp data was imported into. More...
 
bool ShowView (out HPS.View out_view)
 Shows the view where the main SketchUp camera was imported into. 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 bool operator!= (HPS.Sketchup.ImportResultsKit a, HPS.Sketchup.ImportResultsKit b)
 
static bool operator== (HPS.Sketchup.ImportResultsKit a, HPS.Sketchup.ImportResultsKit 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 ImportResultsKit class contains the results of a successful SketchUp import.

Constructor & Destructor Documentation

HPS.Sketchup.ImportResultsKit.ImportResultsKit ( )

The default constructor creates an empty ImportResultsKit object.

HPS.Sketchup.ImportResultsKit.ImportResultsKit ( HPS.Sketchup.ImportResultsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to copy.

Member Function Documentation

override bool HPS.Sketchup.ImportResultsKit.Empty ( )
virtual

Indicates whether this ImportResultsKit has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.Sketchup.ImportResultsKit.Equals ( HPS.Sketchup.ImportResultsKit  in_kit)

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_sketchup_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.Sketchup.ImportResultsKit.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.ImportResultsKit.Set ( HPS.Sketchup.ImportResultsKit  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_sketchup_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to copy.
void HPS.Sketchup.ImportResultsKit.Show ( out HPS.Sketchup.ImportResultsKit  out_kit)

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_sketchup_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_sketchup_1_1_import_results_kit" kindref="compound">ImportResultsKit</ref>.
bool HPS.Sketchup.ImportResultsKit.ShowMainCamera ( out HPS.CameraKit  out_camera)

Shows the camera where the main SketchUp camera was imported into.

Parameters
out_cameraCameraKit where main SketchUp camera was imported into
Returns
true if a valid camera was imported, false otherwise.
bool HPS.Sketchup.ImportResultsKit.ShowPortfolio ( out HPS.PortfolioKey  out_portfolio)

Shows the PortfolioKey where the SketchUp data was imported into.

Parameters
out_portfolioPortfolio the SketchUp data was imported into.
Returns
true if a valid Portfolio is set, false otherwise.
bool HPS.Sketchup.ImportResultsKit.ShowScenes ( out string[]  out_names,
out HPS.CameraKit[]  out_cameras 
)

Shows the scenes imported from SketchUp.

Parameters
out_namesUTF8Array where SketchUp scene names were imported into.
out_camerasCameraKitArray where SketchUp scene cameras were imported into.
Returns
true if valid names and cameras are set, false otherwise.
bool HPS.Sketchup.ImportResultsKit.ShowTarget ( out HPS.SegmentKey  out_target,
out HPS.SegmentKey  out_library 
)

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

Parameters
out_targetSegment the SketchUp data was imported into.
out_librarySegment the SketchUp includes data was imported into.
Returns
true if a valid target and library segment are set, false otherwise.
bool HPS.Sketchup.ImportResultsKit.ShowTarget ( out HPS.Model  out_model)

Shows the Model where the SketchUp data was imported into.

Parameters
out_modelModel to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
Returns
true if a Model was specified on import, false otherwise.
bool HPS.Sketchup.ImportResultsKit.ShowView ( out HPS.View  out_view)

Shows the view where the main SketchUp camera was imported into.

Parameters
out_viewView where main SketchUp camera was imported into.
Returns
true if a View was specified on import, false otherwise.

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