Interface ILspImageProjector

All Known Implementing Classes:
TLspImageProjector

public interface ILspImageProjector
Defines a projector used by an ILspImageProjectionLayer. A projector can be thought of (as its name implies) as a virtual slide projector, which is positioned somewhere in the world and casts an image in a certain direction.

The projector is defined by the following parameters:

  • Eye point: the position of the projector in the world;
  • Reference point: a point at which the projector is pointed;
  • Up vector: a normalized vector, relative to the eye point, which defines the "up" direction in the projector's local coordinate frame (i.e. which determines the projector's roll angle around its line of sight axis);
  • Aspect ratio: the ratio of the projected image's width and height;
  • Field of view: the projector's vertical field of view angle;
  • Range: the maximum distance from the eye point to which the projector's image should be cast.
Note that all parameters are specified in model coordinates.
Since:
2012.0
  • Method Details Link icon

    • getEyePoint Link icon

      ILcdPoint getEyePoint()
      Returns the projector's eye point. This is position of the projector in the world.
      Returns:
      the projector's eye point
    • getReferencePoint Link icon

      ILcdPoint getReferencePoint()
      Returns the projector's reference point. This is the point at which the projector is pointed.
      Returns:
      the projector's reference point
    • getUpVector Link icon

      ILcdPoint getUpVector()
      Returns the projector's up vector. This is a normalized vector, relative to the eye point, which defines the "up" direction in the projector's local coordinate frame (i.e. which determines the projector's roll angle around its line of sight axis).
      Returns:
      the projector's up vector
    • getAspectRatio Link icon

      double getAspectRatio()
      Returns the projector's aspect ratio. This is the ratio of the projected image's width and height.
      Returns:
      the projector's aspect ratio
    • getFieldOfView Link icon

      double getFieldOfView()
      Returns the projector's vertical field of view, in degrees.
      Returns:
      the projector's vertical field of view
    • getRange Link icon

      double getRange()
      Returns the projector's distance range. This is the maximum distance from the eye point to which the projector's image should be cast. The projector's image will not be visible beyond this distance.
      Returns:
      the projector's distance range