artisynth.core.renderables

Class FaceList<P extends FaceComponent>

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ComponentList<C>

artisynth.core.modelbase.RenderableComponentList<P>

artisynth.core.renderables.FaceList<P>

All Implemented Interfaces:

ComponentChangeListener, ComponentListView<P>, CompositeComponent, IndexedComponentList, ModelComponent, MutableCompositeComponent<P>, PostScannable, RenderableComponent, RenderableComponentListView<P>, java.lang.Cloneable, java.lang.Iterable<P>, java.util.Collection<P>, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, ListView<P>, ParameterizedClass, Scannable

public class FaceList<P extends FaceComponent>
extends RenderableComponentList<P>

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.NavpanelVisibility

Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent

CompositeComponent.NavpanelDisplay

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SELECTABLE
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ComponentList

DEFAULT_NAVPANEL_DISPLAY

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
FaceList(java.lang.Class<P> type, java.lang.String name, java.lang.String shortName)

Method Summary

Modifier and Type	Method and Description
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
void	getSelection(java.util.LinkedList<java.lang.Object> list, int qid) Append to list the component (or components) associated with the qid-th selection query issued by this component's render method.
boolean	isSelectable() Returns true if this object is in fact selectable.
int	numSelectionQueriesNeeded() If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required.
void	prerender(RenderList list) Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
boolean	rendersSubComponents() Queries if this list automatically renders any subcomponents which do not have their own render props.
void	setSelectable(boolean enable)

Methods inherited from class artisynth.core.modelbase.RenderableComponentList

getRenderHints, getRenderProps, setRenderProps, updateBounds

Methods inherited from class artisynth.core.modelbase.ComponentList

add, add, addAll, addComponents, addFixed, addNumbered, clear, clone, componentChanged, contains, contains, containsAll, copy, ensureCapacity, findComponent, get, get, getByNumber, getChildren, getNavpanelDisplay, getNumberLimit, getOneBasedNumbering, getParameterType, getShortName, hasChildren, hasParameterizedType, hierarchyContainsReferences, indexOf, invalidateNumbers, isEditable, isEmpty, iterator, nextComponentNumber, numComponents, postscan, remove, remove, removeAll, removeAll, removeComponents, resetNumbersToIndices, retainAll, scan, set, setEditable, setNavpanelDisplay, setNumbered, setOneBasedNumbering, setShortName, size, toArray, toArray, updateNameMap

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface artisynth.core.modelbase.ComponentListView

contains, get, get, getByNumber, getName, getShortName, indexOf, iterator, nextComponentNumber, size

Methods inherited from interface maspack.util.ListView

contains

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

DEFAULT_SELECTABLE

public static boolean DEFAULT_SELECTABLE

myProps

public static PropertyList myProps

Constructor Detail

FaceList

public FaceList(java.lang.Class<P> type,
                java.lang.String name,
                java.lang.String shortName)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class RenderableComponentList<P extends FaceComponent>

Returns:

static information for all exported properties

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface RenderableComponentListView<P extends FaceComponent>

Specified by:

createRenderProps in interface HasRenderProps

Overrides:

createRenderProps in class RenderableComponentList<P extends FaceComponent>

Returns:

new render properties for this object

prerender

public void prerender(RenderList list)

Description copied from interface: IsRenderable

Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling

list.addIfVisible (obj);

for each of the objects in question.

Specified by:

prerender in interface IsRenderable

Overrides:

prerender in class RenderableComponentList<P extends FaceComponent>

Parameters:

list - list of objects to be rendered

rendersSubComponents

public boolean rendersSubComponents()

Description copied from class: RenderableComponentList

Queries if this list automatically renders any subcomponents which do not have their own render props.

Overrides:

rendersSubComponents in class RenderableComponentList<P extends FaceComponent>

Returns:

true if this list renders subcomponents without render props

render

public void render(Renderer renderer,
                   int flags)

Description copied from interface: IsRenderable

Render this object using the functionality of the supplied Renderer.

Specified by:

render in interface IsRenderable

Overrides:

render in class RenderableComponentList<P extends FaceComponent>

Parameters:

renderer - provides the functionality used to perform the rendering.

flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.

isSelectable

public boolean isSelectable()

Returns true if this object is in fact selectable.

Specified by:

isSelectable in interface IsSelectable

Overrides:

isSelectable in class RenderableComponentList<P extends FaceComponent>

Returns:

true if this object is selectable

setSelectable

public void setSelectable(boolean enable)

numSelectionQueriesNeeded

public int numSelectionQueriesNeeded()

Description copied from interface: IsSelectable

If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required. Otherwise, this method should return -1.

Specified by:

numSelectionQueriesNeeded in interface IsSelectable

Overrides:

numSelectionQueriesNeeded in class RenderableComponentList<P extends FaceComponent>

Returns:

maximum number of selection queries needed by this component, or -1 if this component does not manage its own selection.

getSelection

public void getSelection(java.util.LinkedList<java.lang.Object> list,
                         int qid)

Description copied from interface: IsSelectable

Append to list the component (or components) associated with the qid-th selection query issued by this component's render method. This will only be called if this component manages its own selection (i.e., the number nums returned by IsSelectable.numSelectionQueriesNeeded() is positive), and qid will in turn be a number between 0 and nums-1.

Specified by:

getSelection in interface IsSelectable

Overrides:

getSelection in class RenderableComponentList<P extends FaceComponent>

Parameters:

list - selected objects are appended to the end of this list

qid - index of the selection query