o2c for Programmers
o2c Player Help File for Programmers Introduction

This reference material describes the ways that the o2c Player can be used in your own programs as an ActiveX control. This includes Java applets on Internet pages, so the distinction between the use of the o2c Player on HTML pages (as described in the separate documentation "The o2c Player for HTML Developers") and the program application described in this help file is fluid.

All of the properties that you need to use the o2c Player on static HTML pages (i.e., Internet pages without the use of JavaScript, VBScript or Java applets) have been described from the viewpoint of an HTML developer in the above-mentioned documentation. For these applications, the descriptions in the HTML documentation, although not complete, are fully adequate. This help file, on the other hand, gives you the complete documentation of all properties, functions, events and file types of the o2c Player.

You will not find detailed instructions on integrating the o2c Player into your program environment here. This is an ActiveX control, and its embedding in your environment is standardized and as a rule very simple. Because of the different technologies for use of the o2c Player in Navigator and Internet Explorer, JavaScript and Java programmers require special treatment. Please read the Tips for JavaScript Programmers and the Tips for Java Programmers.

The user interface of the o2c Player can be configured for the most part. All actions and properties which can be changed interactively can also be changed by programming. You can find the assignment of the interface elements to the configuration and programmer interface in the Attachment.

Download o2c Player Help File for Programmers (160kb)

HTML Parameters
Download o2c HTML sample (141kb)

The following parameters can be used to set the appearance of an o2c object that has been embedded into an HTML document.  In Microsoft FrontPage the o2cPlayer.OCX is known as a Web Component or ActiveX Control.

AnimateOnClick
<PARAM NAME="AnimateOnClick" VALUE="-1">
Disables/enables animation start on click

AnimPlaying
<PARAM NAME="AnimPlaying" VALUE="0">
Start animation automatically after loading object (0=False, 1=True)

AnimSpeed
<PARAM NAME="AnimSpeed" value="1">
Factor by which the animation is accelerated (>1) or decelerated (<1)

Appearance
<PARAM NAME="Appearance" VALUE="0">
Sets the border style to either flat (value=0), or three-dimensional (value=1).

BackColor
<PARAM NAME="BackColor" VALUE="16777215">
Sets the background color.  To convert from RGB to decimal, use the following formula.
(R*256 + G)*256 + B
 
 Color RGB Decimal Hex
 White 255 255 255 16777215 FFFFFF
 Black 0 0 0 0 000000
 Grey 128 128 128 8421504 808080
 Red 255 0 0 16711680 FF0000
 Green 0 255 0 65280 00FF00
 Blue 0 0 255 255 0000FF
 Cyan 0 255 255 65535 00FFFF
 Magenta 255 0 255 16711935 FF00FF
 Yellow 255 255 0 16776960 FFFF00

BackPicMode
<PARAM NAME="BackPicMode" VALUE="2">
Background Picture Mode (0 = Solid Color, 1 = Fit to Display, 2 = Tile)

BackPicOffsetX
<PARAM NAME="BackPicOffsetX" VALUE="0">
Background picture horizontal offset in pixels

BackPicOffsetY
<PARAM NAME="BackPicOffsetY" VALUE="0">
Background picture vertical offset in pixels

BackPictureURL
<PARAM NAME="BackPictureURL" VALUE="o2c_Background.jpg">
Specify path for background image (BMP or JPEG)

BackStyle
<PARAM NAME="BackStyle" VALUE="1">
Note: This parameter is ignored (0 = Transparent, 1 = Opaque)

BorderStyle
<PARAM NAME="BorderStyle" VALUE="1">
Disables/Enables the border

ButtonRayTraceEnabled
<PARAM NAME="ButtonRayTraceEnabled" VALUE="1">
Disables/Enables Start Raytrace menu option

ButtonVREnabled
<PARAM NAME="ButtonVREnabled" VALUE="0">
Requires expanded version of o2c Player and additional DLLs used in ArCon products

CurrentObject
If several objects are displayed: the object currently being processed (by program)

CurrentTime
The current animation time

DelayAfterPreview
<PARAM NAME="DelayAfterPreview" VALUE="0">
Delay in milliseconds before object is displayed after preview is displayed

DelayBeforeLoad
<PARAM NAME="DelayBeforeLoad" VALUE="0">
Delay in milliseconds before object is loaded after control is displayed

DisplayMode
<PARAM NAME="DisplayMode" VALUE="3">
0 = Wireframe
1 = Flat Shaded
2 = Flat Shaded/Textures
3 = Shaded/Textures
4 =  Wireframe/HLR
Other values = 5, 6, 7, 16, 20, 21, 22, 23 ,32

DragDropEnabled
<PARAM NAME="DragDropEnabled" value="1">
     
Enabled
<PARAM NAME="Enabled" VALUE="1">
Disables/Enables cursor controls and context-sensitive menu

EnabledMenus
<PARAM NAME="EnabledMenus" VALUE="-1">
Sets available menu commands

EyeX
<PARAM NAME="EyeX" value="100">
Sets X coordinate of eye point
 

EyeY
<PARAM NAME="EyeY" value="100">
     Sets Y coordinate of eye point

EyeZ
<PARAM NAME="EyeZ" value="100">
Sets Z coordinate of eye point

Filter
<PARAM NAME="Filter" VALUE="0">
Disables/enables edge filter (anti-alias)

FlatTextturePath
<PARAM NAME="FlatTexturePath" VALUE="0">
Obsolete parameter for compatibility

Height
<PARAM NAME="_cy" VALUE="5000">
Height of the ActiveX control.

HideControls
<PARAM NAME="HideControls" VALUE="1">
Enables/Disables display of control bars

HideScrollBars
<PARAM NAME="HideScrollBars" VALUE="0">
Similar to HideControls, this parameter enables or disables the display of scroll bars.

IncrementDisplay
<PARAM NAME="IncrementalDisplay" VALUE="0">
Disables/Enables the partial display of objects before they are completely downloaded

InhibitLocalTextures
<PARAM NAME="InhibitLocalTextures" value="1">
Prohibits the use of external textures

KeepSpinning
<PARAM NAME="KeepSpinning" VALUE="0">
Disables/Enables Automatic Rotation

Language
<PARAM NAME="Language" VALUE="EN">
Set language of the display (EN = English, DE = German)

Lights
<PARAM NAME="Lights" value="0">
Set value (bit encoded 8-bit word) for lights
0 = All off
1 = Sunlight only
2 = Ambient light #1 only
4 = Ambient light #2 only
8 = Ambient light #3 only
14 = Ambient lights 1, 2, and 3 only
16 = Lamps only
17 = Sunlight and Lamps only
31 = All on

LoadObjectMenuEnabled
<PARAM NAME="LoadObjectMenuEnabled" VALUE="1">
Disables/Enables display of Load object... menu option

LocalSaveAllowed
<PARAM NAME="LocalSaveAllowed" VALUE="-1">
Allows local saving of the downloaded object and its textures
Object will be saved as a non-compressed ACO file
Texture will be saved in BMP format

MenuNameFor3D
<PARAM NAME="MenuNameFor3D" VALUE="Switch to object display">
Menu label for display object option

MneuNameForPreview
<PARAM NAME="MenuNameForPreview" VALUE="Switch to preview display">
Menu label for display preview option

ObjectUID
<PARAM NAME="ObjectUID" value="0C9F5A8D-FC88-11d2-ADD4-00A0C9251384">
Unique identification of the object

ObjectURL
<PARAM NAME="ObjectURL" VALUE="EHM-House.o2c">
Set path for o2c object

PanX
PARAM NAME="PanX" VALUE="0">
Pans display left/right (0.5 = 50% to the right if zoom = 1.0)

PanY
<PARAM NAME="PanY" VALUE="0">
Pans display down/up (0.5 = 50% up if zoom = 1.0)

Phi
<PARAM NAME="Phi" VALUE="225">
Rotation about the Z-axis (in degrees, positive values rotate counter-clockwise)

PopupMenuEnabled
<PARAM NAME="PopupMenuEnabled" VALUE="1">
Disables/Enables context-sensitive menu

PreviewMode
<PARAM NAME="PreviewMode" VALUE="3">
Settings for thumbnail preview
0 = Remain in background
1 = Display until first click
2 = Display until object is displayed
3 = Default, Display until background image is displayed

Psi
<PARAM NAME="Psi" VALUE="45">
Rotation about the X-axis (in degrees, positive values rotate downward)

SaveFilesWithDocument
<PARAM NAME="SaveFilesWithDocument" VALUE="-1">
Save object and textures in OLE documents or save only file name

SpinPhi
<PARAM NAME="SpinPhi" VALUE="0">
Rotation about the Z-axis in degrees per second

SpinPsi
<PARAM NAME="SpinPsi" VALUE="0">
Rotation about the X-axis in degrees per second

TextureBaseURL
<PARAM NAME="TextureBaseURL" VALUE=".">
Set URL prefix to search for textures on the web.

TexturePath
<PARAM NAME="TexturePath" valuetype="ref" value=".">
Gives the local path where the textures can be found.

TooltipTimeout
<PARAM NAME="TooltipTimeout" VALUE="750">
Delay in milliseconds before a tool tip is displayed (Disable with -1)

VisuDLL
<PARAM NAME="VisuDLL" valuetype="ref" value=".">
Path to visualization DLL in the expanded Version

VRPx
<PARAM NAME="VRPx" value="100">
     Sets X coordinate of the focal point

VRPy
<PARAM NAME="VRPy" value="100">
     Sets Y coordinate of the focal point

VRPz
<PARAM NAME="VRPz" value="100">
     Sets Z coordinate of the eye point

Walkthrough
<PARAM NAME="Walkthrough" VALUE="1">
Disables/Enables Walk-through mode

Width
<PARAM NAME="_cx" VALUE="5000">
Width of the ActiveX control.

Zoom
<PARAM NAME="Zoom" VALUE="1">
Enargement factor (Zoom) of display (1 = Show All or 100%)

EOF