Module org.bzdev.anim2d

Package org.bzdev.anim2d

Class PolarGridFactory

java.lang.Object

org.bzdev.obnaming.NamedObjectFactory<F,Simulation,SimObject,OBJ>

org.bzdev.devqsim.SimObjectFactory<AnimationObject2DFactory<Obj>,Animation2D,Obj>

org.bzdev.anim2d.AnimationObject2DFactory<Obj>

org.bzdev.anim2d.AbstrPolarGridFactory<PolarGrid>

org.bzdev.anim2d.PolarGridFactory

All Implemented Interfaces:

Cloneable

public final class PolarGridFactory
extends AbstrPolarGridFactory<PolarGrid>

Factory for creating polar grids. The parameters this factory supports are shown in the following table:

Nested Class Summary

Nested classes/interfaces inherited from class org.bzdev.obnaming.NamedObjectFactory

NamedObjectFactory.ConfigException, NamedObjectFactory.IndexedSetter, NamedObjectFactory.ParmNameIterator

Constructor Summary

Constructors

Constructor	Description
PolarGridFactory()	Constructor for service provider.
PolarGridFactory(Animation2D a2d)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected PolarGrid	newObject(String name)	Construct a new object.

Methods inherited from class org.bzdev.anim2d.AbstrPolarGridFactory

initObject

Methods inherited from class org.bzdev.anim2d.AnimationObject2DFactory

addToTimelineRequest, clear, getAnimation, getVisibility, getZorder, setAnimationObjectDefaults

Methods inherited from class org.bzdev.devqsim.SimObjectFactory

addToTimelineResponse, getSimulation

Methods inherited from class org.bzdev.obnaming.NamedObjectFactory

add, add, add, add, add, add, add, add, addDocResourceBundle, addDocResourceBundle, addJDoc, addJDoc, addLabelResourceBundle, addLabelResourceBundle, addTipResourceBundle, addTipResourceBundle, arrayInit, canAdd3, clear, configure, configureSupported, containsParm, createObject, createObject, createObject, createObject, createObjects, createObjects, createObjects, createObjects, createObjects, createObjects, doAfterInits, endObjectCreation, getDoc, getFactoryClass, getGLB, getLabel, getLayoutResource, getListedFactories, getLUB, getNextName, getNextNameIndex, getObjectNamer, getParmKeyType, getParmPrefix, getRVMode, getTemplateKeyMap, getTemplateKeyMapForFactories, getTemplateKeyMapForFactories, getTemplateKeyMapForFactories, getTip, getType, glbInRange, initParm, initParms, initParms, isClearOnly, isNamedObject, isRandomVariable, keyType, lubInRange, mustAdd, newConfigExceptionInstance, newConfigExceptionInstance, newConfigExceptionInstance, newConfigExceptionInstance, newConfigExceptionInstance, newConfigExceptionInstance, newConfigExceptionInstance, newInstance, newInstance, parmNames, parmNameSet, parmPrefixes, remove, remove, remove, remove, remove, remove, remove, remove, removeParm, removeParms, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, setDocAPIBase, setInterned, setLayoutResource, setLayoutResource, setNameRoot, setTarget, startObjectCreation, unset, unset, unset, unset, unset, unset, willIntern

Methods inherited from class java.lang.Object

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

Constructor Details

PolarGridFactory

public PolarGridFactory(Animation2D a2d)

Constructor.

Parameters:

a2d - the animation

PolarGridFactory

public PolarGridFactory()

Constructor for service provider. This constructor should not be used directly. It is necessary because of the introduction of modules in Java 9, and is used by a service provider that allows factories to be listed, possibly with documentation regarding their parameters. It just calls the default constructor with a null argument.

Method Details

newObject

protected PolarGrid newObject(String name)

Description copied from class: NamedObjectFactory

Construct a new object. The object will not be initialized. This method is called by createObject() and createObjects unless these methods are overridden. Subclasses should call willIntern() to determine if the object will interned or not, and getObjectNamer() to find the object namer. Some subclasses (e.g., org.devqsim.SimObjectFactory) provide a method that will return the object namer cast to the type needed by constructors. In the case of SimObjectFactory, this method is named getSimulation(). For a subclass of SimObjectFactory to create a new object of type Foo, newObject will execute the expression

      new Foo(getSimulation(), name, willIntern())
 

or an equivalent expression, where name is the argument passed to newObject.

Specified by:

newObject in class NamedObjectFactory<AnimationObject2DFactory<PolarGrid>,Simulation,SimObject,PolarGrid>

Parameters:

name - the name of the object to be created

Returns:

the new object

See Also:

• NamedObjectFactory.willIntern()
• NamedObjectFactory.setInterned(boolean)
• NamedObjectFactory.getObjectNamer()