public interface ResultFeature extends ResultBaseFeature, ViewBase, ViewFeature
Modifier and Type | Method and Description |
---|---|
ResultFeature |
create(java.lang.String tag,
java.lang.String type)
Create a result feature.
|
TableFeature |
createTable(java.lang.String tableTag)
Creates a table containing the data for the plot.
|
void |
discardFile()
Discard the file that this plot feature uses.
|
void |
exportFile(java.lang.String filename)
Export the file that this plot feature uses.
|
ResultFeatureList |
feature()
Gets the list of sub-features for this ResultFeature.
|
ResultFeature |
feature(java.lang.String tag)
Get the sub-feature with the given name, or an exception otherwise.
|
java.lang.String[] |
getAxisUnits()
Returns the units of the coordinate axes for the plot group to which
the feature belong; null for 1D plot groups.
|
int[][] |
getBoundaryElements(int renderIndex,
int groupIndex)
Get the elements for the boundary of the current plot, if applicable.
|
double[] |
getColor(java.lang.String name,
boolean useGraphicsTheme)
Returns the color specified by a property.
|
double[] |
getColor(java.lang.String name,
java.lang.String colorTheme)
Returns the color specified by a property.
|
float[] |
getData(int renderIndex,
int groupIndex,
java.lang.String dataType)
Get the data vector for a specific data type.
|
float[] |
getDataMinMax(int renderIndex,
int groupIndex,
java.lang.String dataType)
Get the maximum and minimum data for a specific data type.
|
java.lang.String[] |
getDataTypes(int renderIndex)
Gets the available data types within the plot.
|
int[][] |
getElements(int renderIndex,
int groupIndex)
Gets the elements of the plot.
|
int |
getGroups(int renderIndex)
Retrieves the number of groups for a rendering type.
|
float[][] |
getNormals(int renderIndex,
int groupIndex)
Gets the vertex normals.
|
ResultFeature |
getPlotGroup()
Resolves the plot group this result feature belongs to.
|
int |
getRenderGroups()
Returns the number of rendering types within the plot.
|
int |
getSDim()
Get this feature's space dimension.
|
int[] |
getVertexElements(int renderIndex,
int groupIndex)
Gets the element each vertex belongs to.
|
float[][] |
getVertices(int renderIndex,
int groupIndex)
Gets the vertex coordinates.
|
void |
importFile()
Import the file that this plot feature uses.
|
boolean |
isPlotGroup()
Returns
true if this result feature is a plot group. |
ViewFeature |
prepareView(boolean create)
Returns the view to use when plotting the plot group to which the
feature belongs.
|
void |
refreshFile()
Refresh the file that this plot feature uses.
|
void |
run()
Generate and render data for plot group.
|
LocalSelection |
selection(java.lang.String name)
Returns a selection property.
|
hasWarning, problem, problem, runCommand
axis, camera, clip, clip, hideEntities, hideEntities, hideMesh, hideMesh, hideObjects, hideObjects, light, light
getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex
selection
active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version
getContainer, getDisplayString
ResultFeature create(java.lang.String tag, java.lang.String type)
tag
- Feature tag.type
- Type of feature.TableFeature createTable(java.lang.String tableTag)
tableTag
- The table tag.void discardFile()
void exportFile(java.lang.String filename)
filename
- File name.ResultFeatureList feature()
ResultFeature feature(java.lang.String tag)
tag
- Result feature tag.java.lang.String[] getAxisUnits()
int[][] getBoundaryElements(int renderIndex, int groupIndex)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.double[] getColor(java.lang.String name, java.lang.String colorTheme)
name
- Property name.colorTheme
- If the property is set to take the color from a color theme, use this
theme.double[] getColor(java.lang.String name, boolean useGraphicsTheme)
name
- Property name.useGraphicsTheme
- If true, use the model's graphics color theme, If false, use the
model's image export color theme.float[] getData(int renderIndex, int groupIndex, java.lang.String dataType)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.dataType
- Plot data type; use getDataTypes to determine supported plot data
types.float[] getDataMinMax(int renderIndex, int groupIndex, java.lang.String dataType)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.dataType
- Plot data type; use getDataTypes to determine supported plot data
types.java.lang.String[] getDataTypes(int renderIndex)
renderIndex
- Rendering index indicating rendering type within plot.Color
.int[][] getElements(int renderIndex, int groupIndex)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.int getGroups(int renderIndex)
renderIndex
- Rendering type index.float[][] getNormals(int renderIndex, int groupIndex)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.ResultFeature getPlotGroup()
int getRenderGroups()
int getSDim()
int[] getVertexElements(int renderIndex, int groupIndex)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.float[][] getVertices(int renderIndex, int groupIndex)
renderIndex
- Rendering index indicating rendering type within plot.groupIndex
- Group index indicating groups or part within rendering group index.void importFile()
boolean isPlotGroup()
true
if this result feature is a plot group.true
if a plot group.ViewFeature prepareView(boolean create)
create
- If true, the view is created if needed.void refreshFile()
void run()
LocalSelection selection(java.lang.String name)
selection
in interface PropFeature
name
- Selection property name.