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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Sketchup.ImportResultsKit in_kit)
 
override int GetHashCode ()
 
 ImportResultsKit ()
 
 ImportResultsKit (HPS.Sketchup.ImportResultsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Sketchup.ImportResultsKit in_kit)
 
void Show (out HPS.Sketchup.ImportResultsKit out_kit)
 
bool ShowMainCamera (out HPS.CameraKit out_camera)
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 
bool ShowScenes (out string[] out_names, out HPS.CameraKit[] out_cameras)
 
bool ShowTarget (out HPS.SegmentKey out_target, out HPS.SegmentKey out_library)
 
bool ShowTarget (out HPS.Model out_model)
 
bool ShowView (out HPS.View out_view)
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImportResultsKit() [1/2]

HPS.Sketchup.ImportResultsKit.ImportResultsKit ( )
inline

The default constructor creates an empty ImportResultsKit object.

◆ ImportResultsKit() [2/2]

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

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

Parameters
in_kitThe source ImportResultsKit to copy.

Member Function Documentation

◆ Empty()

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

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.

◆ Equals()

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

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

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

◆ ObjectType()

override HPS.Type HPS.Sketchup.ImportResultsKit.ObjectType ( )
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.

◆ Set()

void HPS.Sketchup.ImportResultsKit.Set ( HPS.Sketchup.ImportResultsKit  in_kit)
inline

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.

◆ Show()

void HPS.Sketchup.ImportResultsKit.Show ( out HPS.Sketchup.ImportResultsKit  out_kit)
inline

Copies this ImportResultsKit into the given ImportResultsKit.

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

◆ ShowMainCamera()

bool HPS.Sketchup.ImportResultsKit.ShowMainCamera ( out HPS.CameraKit  out_camera)
inline

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.

◆ ShowPortfolio()

bool HPS.Sketchup.ImportResultsKit.ShowPortfolio ( out HPS.PortfolioKey  out_portfolio)
inline

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.

◆ ShowTarget() [1/2]

bool HPS.Sketchup.ImportResultsKit.ShowTarget ( out HPS.SegmentKey  out_target,
out HPS.SegmentKey  out_library 
)
inline

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.

◆ ShowTarget() [2/2]

bool HPS.Sketchup.ImportResultsKit.ShowTarget ( out HPS.Model  out_model)
inline

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.

◆ ShowView()

bool HPS.Sketchup.ImportResultsKit.ShowView ( out HPS.View  out_view)
inline

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:
  • internals/hps_sprk_sketchup/source/cs/HPS.Sketchup.cs