com.luciad.lucy.util.context

LuciadLightspeedClass TLcyModelEncoderContext

java.lang.Object

com.luciad.lucy.util.context.TLcyModelEncoderContext

public class TLcyModelEncoderContext
extends Object

This context object defines everything related to an ILcdModelEncoder, more specifically it defines the ILcdModel it is about to encode.

Constructor Summary

Constructors

Constructor and Description
TLcyModelEncoderContext(ILcdModelEncoder aModelEncoder) Creates a new TLcyModelEncoderContext object for the given aModelEncoder.
TLcyModelEncoderContext(ILcdModelEncoder aModelEncoder, ILcdModel aModelToEncode) Creates a new TLcyModelEncoderContext object for the given aModelEncoder.
TLcyModelEncoderContext(ILcdModelEncoder aModelEncoder, ILcdModel aModelToEncode, ILcdLayer aLayer, ILcdView aView) Creates a new TLcyModelEncoderContext object for the given aModelEncoder.

Method Summary

Modifier and Type	Method and Description
ILcdLayer	getLayer() Returns the layer of the model that will be encoded.
ILcdModelEncoder	getModelEncoder() Returns the model encoder for which the properties need to be customized.
ILcdModel	getModelToEncode() Returns the model that the associated model encoder will have to encode.
ILcdView	getView() Returns the view in which the model that will be encoded is displayed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyModelEncoderContext

public TLcyModelEncoderContext(ILcdModelEncoder aModelEncoder)

Creates a new TLcyModelEncoderContext object for the given aModelEncoder. The model to encode is null.

Parameters:

aModelEncoder - The ILcdModelEncoder for which this object is the context. This must not be null.

TLcyModelEncoderContext

public TLcyModelEncoderContext(ILcdModelEncoder aModelEncoder,
                               ILcdModel aModelToEncode)

Creates a new TLcyModelEncoderContext object for the given aModelEncoder.

Parameters:

aModelEncoder - The ILcdModelEncoder for which this object is the context. This must not be null.

aModelToEncode - The model that the encoder will have to encode. This is optional and can be null.

TLcyModelEncoderContext

public TLcyModelEncoderContext(ILcdModelEncoder aModelEncoder,
                               ILcdModel aModelToEncode,
                               ILcdLayer aLayer,
                               ILcdView aView)

Creates a new TLcyModelEncoderContext object for the given aModelEncoder.

Parameters:

aModelEncoder - The ILcdModelEncoder for which this object is the context. This must not be null.

aModelToEncode - The model that the encoder will have to encode. This is optional and can be null.

aLayer - The layer of aModelToEncode. This is optional and can be null

aView - The view in which the model that will be encoded is displayed. This is optional and can be null.

Method Detail

getView

public ILcdView getView()

Returns the view in which the model that will be encoded is displayed.

Returns:

The view in which the model that will be encoded is displayed. This is an optional property and can be null.

getLayer

public ILcdLayer getLayer()

Returns the layer of the model that will be encoded. That layer is contained in the view of this context.

Returns:

the layer of the model that will be encoded. This is an optional property and can be null.

getModelEncoder

public ILcdModelEncoder getModelEncoder()

Returns the model encoder for which the properties need to be customized.

Returns:

The model encoder that needs to be customized. This will never be null.

getModelToEncode

public ILcdModel getModelToEncode()

Returns the model that the associated model encoder will have to encode.

Returns:

The model that will need to be encoded. This is an optional property and can be null.

toString

public String toString()

Overrides:

toString in class Object