HPS::OBJ::ImportOptionsKit

class HPS.OBJ.ImportOptionsKit : public HPS.Kit 

The ImportOptionsKit class contains any settings controlling the import of OBJ files.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

Return: true if no values are set on this ImportOptionsKit, false otherwise.

bool Equals (HPS.OBJ.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to compare to this ImportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ImportOptionsKit (): The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.OBJ.ImportOptionsKit in_kit)

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

Param in_kit: The source ImportOptionsKit to copy.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.OBJ.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

HPS.OBJ.ImportOptionsKit SetHandedness (HPS.Drawing.Handedness in_handedness)

Sets the handedness used to import geometry by the OBJ importer. It should match the World Handedness for best results. Defaults to Right if not set.

Param in_handedness: The handedness used to import geometry.
Return: A reference to this ImportOptionsKit.

HPS.OBJ.ImportOptionsKit SetPortfolio (HPS.PortfolioKey in_portfolio)

Sets the portfolio which will be used when the importing images and textures. If no segment is specified, a portfolio will be created for this purpose during import.

Param in_portfolio: Portfolio that will be used when importing images and textures
Return: A reference to this ImportOptionsKit.

HPS.OBJ.ImportOptionsKit SetSegment (HPS.SegmentKey in_segment)

Sets the root segment where the OBJ data will be imported into. If no segment is specified, a root segment will be created for this purpose during import.

Param in_segment: Segment the OBJ data will be imported into.
Return: A reference to this ImportOptionsKit.

void Show (out HPS.OBJ.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit: The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowHandedness (out HPS.Drawing.Handedness out_handedness)

Shows the handedness used to import geometry.

Param out_handedness: Handedness used to import geometry.
Return: true if a handedness was specified, false otherwise.

bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)

Shows the portfolio which will be used when importing images and textures.

Param out_portfolio: Portfolio that will be used when importing images and textures.
Return: true if a portfolio was specified, false otherwise.

bool ShowSegment (out HPS.SegmentKey out_segment)

Shows the root segment where the OBJ data will be imported into.