Inheritance diagram for HPS.OBJ.ImportResultsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.OBJ.ImportResultsKit in_kit)
 
override int GetHashCode ()
 
 ImportResultsKit ()
 
 ImportResultsKit (HPS.OBJ.ImportResultsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.OBJ.ImportResultsKit in_kit)
 
HPS.OBJ.ImportResultsKit SetHandedness (HPS.Drawing.Handedness in_handedness)
 
HPS.OBJ.ImportResultsKit SetPortfolio (HPS.PortfolioKey in_portfolio)
 
HPS.OBJ.ImportResultsKit SetSegment (HPS.SegmentKey in_segment)
 
void Show (out HPS.OBJ.ImportResultsKit out_kit)
 
bool ShowHandedness (out HPS.Drawing.Handedness out_handedness)
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 
bool ShowSegment (out HPS.SegmentKey out_segment)
 
HPS.OBJ.ImportResultsKit UnsetEverything ()
 
HPS.OBJ.ImportResultsKit UnsetHandedness ()
 
HPS.OBJ.ImportResultsKit UnsetPortfolio ()
 
HPS.OBJ.ImportResultsKit UnsetSegment ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.OBJ.ImportResultsKit a, HPS.OBJ.ImportResultsKit b)
 
static bool operator== (HPS.OBJ.ImportResultsKit a, HPS.OBJ.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 OBJ import.

Constructor & Destructor Documentation

◆ ImportResultsKit() [1/2]

HPS.OBJ.ImportResultsKit.ImportResultsKit ( )
inline

The default constructor creates an empty ImportResultsKit object.

◆ ImportResultsKit() [2/2]

HPS.OBJ.ImportResultsKit.ImportResultsKit ( HPS.OBJ.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.OBJ.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.OBJ.ImportResultsKit.Equals ( HPS.OBJ.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.OBJ.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.Kit.

◆ Set()

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

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.

◆ SetHandedness()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.SetHandedness ( HPS.Drawing.Handedness  in_handedness)
inline

Sets the handedness used when importing geometry. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_handednessHandedness used to import geometry.
Returns
A reference to this ImportResultsKit.

◆ SetPortfolio()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.SetPortfolio ( HPS.PortfolioKey  in_portfolio)
inline

Sets the portfolio which was used when the import file read in images and textures. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_portfolioPortfolio that was used when the file imported images and textures.
Returns
A reference to this ImportResultsKit.

◆ SetSegment()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.SetSegment ( HPS.SegmentKey  in_segment)
inline

Sets the root segment which the OBJ data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_segmentSegment the OBJ data was imported into.
Returns
A reference to this ImportResultsKit.

◆ Show()

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

Copies this ImportResultsKit into the given ImportResultsKit.

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

◆ ShowHandedness()

bool HPS.OBJ.ImportResultsKit.ShowHandedness ( out HPS.Drawing.Handedness  out_handedness)
inline

Shows handedness used to import geometry. This was either the root segment specified by the user in the ImportOptionsKit passed to OBJ.File.Import, or the root segment that was created for this purpose during import.

Parameters
out_handednessSegment the OBJ data was imported into.
Returns
true if a handedness was specified, false otherwise.

◆ ShowPortfolio()

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

Shows the portfolio which was used when the import file read in images and textures. This was either the portfolio specified by the user in the ImportOptionsKit passed to OBJ.File.Import, or the portfolio that was created for this purpose during import.

Returns
true if portfolio was specified, false otherwise.

◆ ShowSegment()

bool HPS.OBJ.ImportResultsKit.ShowSegment ( out HPS.SegmentKey  out_segment)
inline

Shows the root segment which the OBJ data was imported into. This was either the root segment specified by the user in the ImportOptionsKit passed to OBJ.File.Import, or the root segment that was created for this purpose during import.

Parameters
out_segmentSegment the OBJ data was imported into.
Returns
true if a root segment was specified, false otherwise.

◆ UnsetEverything()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.UnsetEverything ( )
inline

Removes all settings from this ImportResultsKit.

Returns
A reference to this ImportResultsKit.

◆ UnsetHandedness()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.UnsetHandedness ( )
inline

Removes the handedness used to import geometry. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

◆ UnsetPortfolio()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.UnsetPortfolio ( )
inline

Removes the portfolio which was used when the import file imported images and textures. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

◆ UnsetSegment()

HPS.OBJ.ImportResultsKit HPS.OBJ.ImportResultsKit.UnsetSegment ( )
inline

Removes the root segment which the OBJ data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.OBJ.cs