Class AbstractPathAbstract

An abstract base class for a ParametricPath.

This was previously "package-private" to ensure that any changes to it are coordinated with all its subclasses.

Hierarchy (view full)

Implements

Constructors

constructor

Methods

getClassName getFinishTValue getName getStartTValue isClosedLoop nameEquals setClosedLoop setFinishTValue setStartTValue toString

Constructors

constructor

  • new AbstractPath(name, localName, startTValue, finishTValue, closedLoop): AbstractPath

  • Parameters

    • name: string

      language independent name

    • localName: string

      localized (internationalized) name

    • startTValue: number

      starting t value for defining path

    • finishTValue: number

      ending t value for defining path

    • closedLoop: boolean

      true means the path is a closed loop

    Returns AbstractPath

Methods

Abstract getClassName

getFinishTValue

getName

  • getName(opt_localized?): string

  • Name of this object, either the language-independent name for scripting purposes or the localized name for display to user.

    The language-independent name should be the same as the English version but capitalized and with spaces and dashes replaced by underscore, see Util.toName and nameEquals.

    Parameters

    • Optional opt_localized: boolean

      true means return the localized version of the name; default is false which means return the language independent name.

    Returns string

    name of this object

getStartTValue

isClosedLoop

nameEquals

  • nameEquals(name): boolean

  • Whether this ParametricPath has the given name, adjusting for the transformation to a language-independent form of the name, as is done by Util.toName.

    Parameters

    • name: string

      the English or language-independent version of the name

    Returns boolean

    whether this ParametricPath has the given name (adjusted to language-independent form)

setClosedLoop

  • setClosedLoop(value): void

  • Sets whether the path is a closed loop, ending at the same point it starts.

    Parameters

    • value: boolean

      whether the path is a closed loop

    Returns void

setFinishTValue

  • setFinishTValue(value): void

  • Sets the ending value for t in the parameteric equation defining the path.

    Parameters

    • value: number

      ending value for t

    Returns void

setStartTValue

  • setStartTValue(value): void

  • Sets the starting value for t in the parameteric equation defining the path.

    Parameters

    • value: number

      starting value for t

    Returns void

toString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc