com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class SkylineBarrier

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.SkylineBarrier

All Implemented Interfaces:

GPTool

public class SkylineBarrier
extends AbstractGPTool

Generates a multipatch feature class representing a skyline barrier. The barrier is in a sense a surface, and looks similar to a triangle fan formed by drawing a line from the observer point to the first vertex of the skyline, then sweeping the line through all of the vertices of the skyline. A skirt and base can optionally be added to form a closed multipatch, giving the appearance of a solid. The Skyline Barrier tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Use the Skyline tool first to generate a skyline.
• If the default value of 0 is specified for the Minimum Radius or Maximum Radius, then there is no minimum or maximum used in the analysis.
• If a positive value is entered for the minimum radius, then each triangle edge emanating from the observer point will be at least that long.
• If a positive value is entered for the maximum radius, then each triangle edge emanating from the observer point will not exceed that length.
• Could be used to determine whether features (such as multipatches representing buildings) "violate" the barrier by protruding up through it, or whether a proposed building would alter the skyline.
• If you choose to create a closed multipatch, then a skirt will be dropped down along the skyline to the base elevation specified in the Base Elevation parameter, and a horizontal surface (a ring) will be created to form the bottom of the closed geometry. If the "Is Closed 3D" tool is run on it, the multipatch will be marked as being closed.
• If the specified base elevation is greater than the highest vertex in the skyline barrier, then the "base" will actually be a ceiling.
• The new multipatch feature class will have the following fields:

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SkylineBarrier()
Creates the Skyline Barrier tool with defaults.

SkylineBarrier(Object inObserverPointFeatures, Object inLineFeatures, Object outFeatureClass)
Creates the Skyline Barrier tool with the required parameters.

Method Summary

Object	getBaseElevation() Returns the Base Elevation parameter of this tool .
String	getClosed() Returns the Closed parameter of this tool .
Object	getInLineFeatures() Returns the Input Line Features parameter of this tool .
Object	getInObserverPointFeatures() Returns the Input Observer Point Features parameter of this tool .
Object	getMaxRadiusValueOrField() Returns the Maximum Radius parameter of this tool .
Object	getMinRadiusValueOrField() Returns the Minimum Radius parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getProjectToPlane() Returns the Project to Plane parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setBaseElevation(Object baseElevation) Sets the Base Elevation parameter of this tool .
void	setClosed(String closed) Sets the Closed parameter of this tool .
void	setInLineFeatures(Object inLineFeatures) Sets the Input Line Features parameter of this tool .
void	setInObserverPointFeatures(Object inObserverPointFeatures) Sets the Input Observer Point Features parameter of this tool .
void	setMaxRadiusValueOrField(Object maxRadiusValueOrField) Sets the Maximum Radius parameter of this tool .
void	setMinRadiusValueOrField(Object minRadiusValueOrField) Sets the Minimum Radius parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setProjectToPlane(String projectToPlane) Sets the Project to Plane parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SkylineBarrier

public SkylineBarrier()

Creates the Skyline Barrier tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

SkylineBarrier

public SkylineBarrier(Object inObserverPointFeatures,
                      Object inLineFeatures,
                      Object outFeatureClass)

Creates the Skyline Barrier tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inObserverPointFeatures - the point feature class containing the observer point(s).

inLineFeatures - the input line feature class which represents the skyline(s).

outFeatureClass - the output feature class into which the skyline barrier is placed.

Method Detail

getInObserverPointFeatures

public Object getInObserverPointFeatures()

Returns the Input Observer Point Features parameter of this tool . This parameter is the point feature class containing the observer point(s). This is a required parameter.

Returns:

the Input Observer Point Features

setInObserverPointFeatures

public void setInObserverPointFeatures(Object inObserverPointFeatures)

Sets the Input Observer Point Features parameter of this tool . This parameter is the point feature class containing the observer point(s). This is a required parameter.

Parameters:

inObserverPointFeatures - the point feature class containing the observer point(s).

getInLineFeatures

public Object getInLineFeatures()

Returns the Input Line Features parameter of this tool . This parameter is the input line feature class which represents the skyline(s). This is a required parameter.

Returns:

the Input Line Features

setInLineFeatures

public void setInLineFeatures(Object inLineFeatures)

Sets the Input Line Features parameter of this tool . This parameter is the input line feature class which represents the skyline(s). This is a required parameter.

Parameters:

inLineFeatures - the input line feature class which represents the skyline(s).

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class into which the skyline barrier is placed. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output feature class into which the skyline barrier is placed. This is a required parameter.

Parameters:

outFeatureClass - the output feature class into which the skyline barrier is placed.

getMinRadiusValueOrField

public Object getMinRadiusValueOrField()

Returns the Minimum Radius parameter of this tool . This parameter is the minimum radius to which triangle edges should be extended from the observer point. The default is 0, meaning no minimum. This is an optional parameter.

Returns:

the Minimum Radius

setMinRadiusValueOrField

public void setMinRadiusValueOrField(Object minRadiusValueOrField)

Sets the Minimum Radius parameter of this tool . This parameter is the minimum radius to which triangle edges should be extended from the observer point. The default is 0, meaning no minimum. This is an optional parameter.

Parameters:

minRadiusValueOrField - the minimum radius to which triangle edges should be extended from the observer point. The default is 0, meaning no minimum.

getMaxRadiusValueOrField

public Object getMaxRadiusValueOrField()

Returns the Maximum Radius parameter of this tool . This parameter is the maximum radius to which triangle edges should be extended from the observer point. The default is 0, meaning no maximum. This is an optional parameter.

Returns:

the Maximum Radius

setMaxRadiusValueOrField

public void setMaxRadiusValueOrField(Object maxRadiusValueOrField)

Sets the Maximum Radius parameter of this tool . This parameter is the maximum radius to which triangle edges should be extended from the observer point. The default is 0, meaning no maximum. This is an optional parameter.

Parameters:

maxRadiusValueOrField - the maximum radius to which triangle edges should be extended from the observer point. The default is 0, meaning no maximum.

getClosed

public String getClosed()

Returns the Closed parameter of this tool . This parameter is whether to close the skyline barrier with a skirt and a base, so that the resulting multipatch will appear to be a solid. This is an optional parameter.

Returns:

the Closed

setClosed

public void setClosed(String closed)

Sets the Closed parameter of this tool . This parameter is whether to close the skyline barrier with a skirt and a base, so that the resulting multipatch will appear to be a solid. This is an optional parameter.

Parameters:

closed - whether to close the skyline barrier with a skirt and a base, so that the resulting multipatch will appear to be a solid.

getBaseElevation

public Object getBaseElevation()

Returns the Base Elevation parameter of this tool . This parameter is the elevation of the base of the closed multipatch; ignored if the barrier is not to be closed. This is an optional parameter.

Returns:

the Base Elevation

setBaseElevation

public void setBaseElevation(Object baseElevation)

Sets the Base Elevation parameter of this tool . This parameter is the elevation of the base of the closed multipatch; ignored if the barrier is not to be closed. This is an optional parameter.

Parameters:

baseElevation - the elevation of the base of the closed multipatch; ignored if the barrier is not to be closed.

getProjectToPlane

public String getProjectToPlane()

Returns the Project to Plane parameter of this tool . This is an optional parameter.

Returns:

the Project to Plane

setProjectToPlane

public void setProjectToPlane(String projectToPlane)

Sets the Project to Plane parameter of this tool . This is an optional parameter.

Parameters:

projectToPlane - null

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias