org.jeospace.x3d
Class PlatformStructure

java.lang.Object
  org.jeospace.x3d.PlatformStructure

All Implemented Interfaces:

Structure

Direct Known Subclasses:

Cockpit

public class PlatformStructure

extends java.lang.Object

implements Structure

A Transform hierarchy supporting simulation components such as ScaledComponents. The PlatformStructure is composed of two Transforms. The base transform level is known as the Plane of the Horizon or the horizon transform for short.

The plane of the horizon transform is used for:

1. positioning the PlatformStructure within the SystemStructure
2. orienting the PlatformStructure with respect to the SystemStructure, typically this will establish the up vector and align the axis' of the horizontal plane in a conventional way (e.g. up is away from the gravitational center and the axis' of the horizontal plane are aligned with the lines of longitude and latitude in the SystemStructure's frame of reference)

The second level Transform is the component transform. The component transform is used for:

1. adding geometry or other components into the PlatformStructure
2. orienting the added geometry with respect to the horizontal plane / gravitational vector established in the horizon transform.

Version:

$Revision: 1.1.1.1 $

Author:

Rex Melton

See Also:

ReferenceFrame, Transform, X3DScene, X3DNode

Field Summary

Transform	component The component transform
Transform	horizon The plane of the horizon transform.

Constructor Summary

PlatformStructure(org.web3d.x3d.sai.X3DScene scene, ReferenceFrame refFrame)
Constructor

Method Summary

void	add(ReferenceFrame refFrame, org.web3d.x3d.sai.X3DNode node) Add the argument node to the specified ReferenceFrame of the PlatformStructure
void	add(ReferenceFrame refFrame, org.web3d.x3d.sai.X3DNode[] node) Add the argument nodes to the specified ReferenceFrame of the PlatformStructure
void	dispose() Explicitly dispose of all the PlatformStructure's resources
void	remove(ReferenceFrame refFrame, org.web3d.x3d.sai.X3DNode node) Remove the argument node from the specified ReferenceFrame of the Structure
void	remove(ReferenceFrame refFrame, org.web3d.x3d.sai.X3DNode[] node) Remove the argument nodes from the specified ReferenceFrame of the Structure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

horizon

public final Transform horizon

The plane of the horizon transform.

component

public final Transform component

The component transform

Constructor Detail

PlatformStructure

public PlatformStructure(org.web3d.x3d.sai.X3DScene scene,
                         ReferenceFrame refFrame)

Constructor

Parameters:

scene - the X3DScene object

refFrame - The reference frame identifier of this structure

Method Detail

add

public void add(ReferenceFrame refFrame,
                org.web3d.x3d.sai.X3DNode node)

Add the argument node to the specified ReferenceFrame of the PlatformStructure

Specified by:

add in interface Structure

Parameters:

refFrame - the reference frame identifier within the structure to add the node to

node - the node to add

add

public void add(ReferenceFrame refFrame,
                org.web3d.x3d.sai.X3DNode[] node)

Add the argument nodes to the specified ReferenceFrame of the PlatformStructure

Specified by:

add in interface Structure

Parameters:

refFrame - the reference frame identifier within the structure to add the nodes to

node - the array of nodes to add

remove

public void remove(ReferenceFrame refFrame,
                   org.web3d.x3d.sai.X3DNode node)

Remove the argument node from the specified ReferenceFrame of the Structure

Specified by:

remove in interface Structure

Parameters:

refFrame - the reference frame identifier within the structure to add the node to

node - the node to remove

remove

public void remove(ReferenceFrame refFrame,
                   org.web3d.x3d.sai.X3DNode[] node)

Remove the argument nodes from the specified ReferenceFrame of the Structure

Specified by:

remove in interface Structure

Parameters:

refFrame - the reference frame identifier within the structure to add the nodes to

node - the array of nodes to remove

dispose

public void dispose()

Explicitly dispose of all the PlatformStructure's resources

Specified by:

dispose in interface Structure