HIOUtilityObj

class HIOUtilityObj

The HIOUtilityObj class reads and writes Alias|Wavefront files. See the following import/export notes and limitations.

The following notes apply to the exporter:

The following geometry types are exported as face geometry

“shell,mesh,polygon,polycylinder,sphere,cylinder,ellipse,circle,circular chord,circular wedge,nurbs surface,grid”

The following geometry types are exported as line geometry "polyline,line,nurbs curve,elliptical arc,circular arc"

Markers are exported as points. Markers use line color.

Line styles, edge styles, and marker styles are not supported.

Geometry will be exported if its net visibility segment is "on". Geometry local visibilities have no effect.

Modelling matrices above the segment you transform will not affect the output. If a user wants to achieve this effect,

he should create a dummy segment with the net ancestor matrix and include the segment he normally would have exported. Export this segment instead and delete it when done. The same applies for visibilities and colors.

Include links are followed unless it is a conditional include with a false condition.

Geometry references are supported.

If exporting from a left-handed system, point X values will be negated.

Textures and environment maps are supported for simple textures. Texture matrices are not supported.

Ambient, diffuse, specular, and transmission colors are supported. If any of the latter three are set at the geometry

level, the exported geometry will have that color. Face-level color settings will not be exported.

The exporter cannot handle holes defined by negative face counts in shell faces. These holes are ignored by the

exporter.

The following notes apply to the importer:

If importing to a left-handed system, point X values will be negated.

Importer no longer sets handedness to right, nor does it set a default color to white.

Importer does not load line data.

Inherits from: HInputHandler, HOutputHandler

Methods

HIOUtilityObj::HIOUtilityObj()

Constructs an HIOUtilityObj object.

virtual HIOUtilityObj::~HIOUtilityObj()

virtual

char const *HIOUtilityObj::GetOutputName()

Returns

A character pointer denoting the name of the handler.
char const *HIOUtilityObj::GetInputName()
void HIOUtilityObj::RegisterInputHandlerTypes()

This method registers the “obj” extension to this handler as an input handler.

char const *HIOUtilityObj::GetInputTypesString()

Returns

The input extension type that is handled by HIOUtilityObj which is “obj”.
HInputHandlerStyle HIOUtilityObj::GetInputStyle()

Returns

The type of input style which is #HInputHandlerStyleModel.
HFileInputResult HIOUtilityObj::FileInputByKey(__wchar_t const *FileName, HC_KEY key, HInputHandlerOptions *options)

This method reads an Alias|Wavefront file. The file contents are mapped to a HOOPS shell primitive that is inserted into the HOOPS segment specified by the key.

Parameters

filename: The name of the file to load.

key: The HOOPS segment key to load model data into.

options: An options class containing any needed extra information for operation.

Returns

The #HFileInputResult result of the input operation.
HFileInputResult HIOUtilityObj::FileInputByKey(char const *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult HIOUtilityObj::FileInputByKey(unsigned short const *FileName, HC_KEY key, HInputHandlerOptions *options)
void HIOUtilityObj::RegisterOutputHandlerTypes()

This method registers the “obj” and “OBJ” extensions to this handler as an output handler.

HOutputHandlerStyle HIOUtilityObj::GetOutputStyle()

Returns

The type of output style which is HOutputHandlerStyleModel.
char const *HIOUtilityObj::GetOutputTypesString()

Returns

The string of the type of output this handler creates which is “obj”.
HFileOutputResult HIOUtilityObj::FileOutputByKey(__wchar_t const *filename, HC_KEY key, HOutputHandlerOptions *options)

This method writes a Alias|Wavefront file out of the segment tree underneath the given key.

Parameters

filename: The name of the file to output.

key: The HOOPS segment key to output model data from.

options: The options class containing any needed extra information for the operation.

Returns

The #HFileOutputResult result of the output operation.
HFileOutputResult HIOUtilityObj::FileOutputByKey(unsigned short const *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult HIOUtilityObj::FileOutputByKey(char const *filename, HC_KEY key, HOutputHandlerOptions *options)