PointVisualizer.LeadLine Property

Gets or sets a value indicating if a lead line should be drawn for offset objects.

Syntax

public System.Boolean LeadLine { get; set; }

Property Value

Type: System.Boolean
Default: false
True if lead lines should be drawn, false otherwise.

Remarks

If this property is True, and the rendering is offset from the original position using the OffsetX, OffsetY and/or OffsetZ properties, a line is drawn from the object's geographic position to the point where it is rendered. How the line is visualized and positioned can be controlled with the LeadLineSettings property. If LeadLineSettings is not specified, the line is drawn in the color of the visualizer, with a width of one pixel.

Lead lines are currently not supported for texts, raster symbols and SVG symbols rendered in 3D, if LengthUnit is set to Pixels.

Example

// Offset the symbol and create a LeadLine to it
public static void SetUpOffsetAndLeadLine(PointVisualizer pointVisualizer)
{
    // This property is a member of a type that might be referred to by a View 
    // or a GlobeView, either directly or indirectly through other objects, which means 
    // that you must use the Guard class to take the global configuration lock when it 
    // is modified to synchronize access with any running Carmenta Engine threads.
    using (Guard guard = new Guard())
    {
        // Set length unit pixels (Default is pixels). 
        pointVisualizer.LengthUnit = VisualizerLengthUnit.Pixels;

        // Offset the Symbol 20 pixels to the right on the X axis 
        pointVisualizer.OffsetX = -20.0;

        // Offset the Symbol 20 pixels to the top on the Y axis
        pointVisualizer.OffsetY = 20.0;

        // For 3D visualization offset the Symbol 20 pixels the Z axis
        pointVisualizer.OffsetZ = 20.0;

        // Visualize a LeadLine 
        pointVisualizer.LeadLine = true;

        // Create LeadLineSettings
        LeadLineSettings leadLineSettings = new LeadLineSettings();

        // Attach the LeadLine to the nearest corner
        leadLineSettings.AttachTo = LeadLineAttachment.NearestCorner;

        // Set a start margin of 2 Pixels
        leadLineSettings.StartMargin = 2.0;

        // Set a end margin of 2 Pixels
        leadLineSettings.EndMargin = 2.0;

        // Set the LeadLineSettings into the PointVisualizer
        pointVisualizer.LeadLineSettings = leadLineSettings;
    }
}

Platforms

Windows, Linux, Android

PointVisualizer::leadLine Property

Gets or sets a value indicating if a lead line should be drawn for offset objects.

Syntax

C++

public:
bool leadLine ( ) const;
void leadLine ( bool value )

Property Value

Type: bool
Default: false
True if lead lines should be drawn, false otherwise.

Remarks

If this property is True, and the rendering is offset from the original position using the offsetX, offsetY and/or offsetZ properties, a line is drawn from the object's geographic position to the point where it is rendered. How the line is visualized and positioned can be controlled with the leadLineSettings property. If leadLineSettings is not specified, the line is drawn in the color of the visualizer, with a width of one pixel.

Lead lines are currently not supported for texts, raster symbols and SVG symbols rendered in 3D, if lengthUnit is set to VisualizerLengthUnitPixels.

Example

C++

// Offset the symbol and create a LeadLine to it
static void setUpOffesetAndLeadLine(PointVisualizerPtr pointVisualizer)
{
    // This property is a member of a type that might be referred to by a View 
    // or a GlobeView, either directly or indirectly through other objects, which means 
    // that you must use the Guard class to take the global configuration lock when it 
    // is modified to synchronize access with any running Carmenta Engine threads.
    Guard guard;

    // Set length unit pixels (Default is pixels). 
    pointVisualizer->lengthUnit(
        new DirectVisualizerLengthUnitAttributeVariable(VisualizerLengthUnitPixels));

    // Offset the Symbol 20 pixels to the right on the X axis 
    pointVisualizer->offsetX(new DirectDoubleAttributeVariable(-20.0));

    // Offset the Symbol 20 pixels to the top on the Y axis
    pointVisualizer->offsetY(new DirectDoubleAttributeVariable(20.0));

    // For 3D visualization offset the Symbol 20 pixels the Z axis
    pointVisualizer->offsetZ(new DirectDoubleAttributeVariable(2.0));

    // Visualize a LeadLine 
    pointVisualizer->leadLine(true);

    // Create LeadLineSettings
    LeadLineSettingsPtr leadLineSettings = new LeadLineSettings();

    // Attach the LeadLine to the nearest corner
    leadLineSettings->attachTo(LeadLineAttachmentNearestCorner);

    // Set a start margin of 2 Pixels
    leadLineSettings->startMargin(new DirectDoubleAttributeVariable(2.0));

    // Set a end margin of 2 Pixels
    leadLineSettings->endMargin(new DirectDoubleAttributeVariable(2.0));

    // Set the LeadLineSettings into the PointVisualizer
    pointVisualizer->leadLineSettings(leadLineSettings);
}

Platforms

Windows, Linux, Android

PointVisualizer.leadLine Property

Gets or sets a value indicating if a lead line should be drawn for offset objects.

Syntax

Java

public final boolean getLeadLine ( );
public final void setLeadLine ( boolean value );

Property Value

Type: boolean
Default: false
True if lead lines should be drawn, false otherwise.

Remarks

Lead lines are currently not supported for texts, raster symbols and SVG symbols rendered in 3D, if lengthUnit is set to PIXELS.

Example

Java

// Offset the symbol and create a LeadLine to it
public static void SetUpOffsetAndLeadLine(PointVisualizer pointVisualizer)
{
    // This property is a member of a type that might be referred to by a View 
    // or a GlobeView, either directly or indirectly through other objects, which means 
    // that you must use the Guard class to take the global configuration lock when it 
    // is modified to synchronize access with any running Carmenta Engine threads.
    Guard guard = new Guard();
    try
    {
        // Set length unit pixels (Default is pixels). 
        pointVisualizer.setLengthUnit(
            new DirectVisualizerLengthUnitAttributeVariable(VisualizerLengthUnit.PIXELS));

        // Offset the Symbol 20 pixels to the right on the X axis 
        pointVisualizer.setOffsetX(new DirectDoubleAttributeVariable(-20.0));

        // Offset the Symbol 20 pixels to the top on the Y axis
        pointVisualizer.setOffsetY(new DirectDoubleAttributeVariable(20.0));

        // For 3D visualization offset the Symbol 20 pixels the Z axis
        pointVisualizer.setOffsetZ(new DirectDoubleAttributeVariable(20.0));

        // Visualize a LeadLine 
        pointVisualizer.setLeadLine(true);

        // Create LeadLineSettings
        LeadLineSettings leadLineSettings = new LeadLineSettings();

        // Attach the LeadLine to the nearest corner
        leadLineSettings.setAttachTo(LeadLineAttachment.NEARESTCORNER);

        // Set a start margin of 2 Pixels
        leadLineSettings.setStartMargin(new DirectDoubleAttributeVariable(2.0));

        // Set a end margin of 2 Pixels
        leadLineSettings.setEndMargin(new DirectDoubleAttributeVariable(2.0));

        // Set the LeadLineSettings into the PointVisualizer
        pointVisualizer.setLeadLineSettings(leadLineSettings);
    }
    finally
    {
        guard.dispose();
    }
}

Platforms

Windows, Linux, Android

PointVisualizer.leadLine Property

Gets or sets a value indicating if a lead line should be drawn for offset objects.

Syntax

Python

leadLine

Property Value

Type: bool
Default: false
True if lead lines should be drawn, false otherwise.

Remarks

Lead lines are currently not supported for texts, raster symbols and SVG symbols rendered in 3D, if lengthUnit is set to VisualizerLengthUnit.Pixels.

Example

Python

# This example is not available in the selected language.

Platforms

Windows, Linux, Android

PointVisualizer.LeadLine Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference

PointVisualizer::leadLine Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference

PointVisualizer.leadLine Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference

PointVisualizer.leadLine Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference