IEcosimShapeFunctionPlugin Interface

Interface for implementing plugin points that provide different types of shape functions.

Namespace: EwEPlugin
Assembly: EwEPlugin (in EwEPlugin.dll) Version: 6.6.15981.0 (6.6.15981.0)

Syntax

public interface IEcosimShapeFunctionPlugin : IPlugin, 
	IShapeFunction

Public Interface IEcosimShapeFunctionPlugin
	Inherits IPlugin, IShapeFunction

type IEcosimShapeFunctionPlugin =  
    interface
        interface IPlugin
        interface IShapeFunction
    end

The IEcosimShapeFunctionPlugin type exposes the following members.

Properties

	Name	Description
	Author	Describes the author of the plugin. (Inherited from IPlugin.)
	Contact	Provides contact information about the plugin. (Inherited from IPlugin.)
	Description	Description of a plug-in. (Inherited from IPlugin.)
	DisplayName	User-friendly display name of a plug-in. (Inherited from IPlugin.)
	IsDistribution	Returns whether the shape function is a true distribution, with fixed min and max values. (Inherited from IShapeFunction.)
	Name	Uniquely identifies a plugin. This field cannot be left empty! (Inherited from IPlugin.)
	nParameters	Get the number of parameters needed to configure a shape function. (Inherited from IShapeFunction.)
	ParamName	Get the human legible name of a parameter of a shape function. (Inherited from IShapeFunction.)
	ParamStatus	Get the order a parameter needs to appear in the UI. Any UI should honour this flag sorting parameters from low to high order. (Inherited from IShapeFunction.)
	ParamUnit	Get the human legible unit for a parameter of a shape function. (Inherited from IShapeFunction.)
	ParamValue	Get/set the value of a parameter of the shape function. (Inherited from IShapeFunction.)
	ShapeFunctionType	Return a (hopefully) unique identifier for a particular shape function, regardless if this function is built-in to EwE or is provided by a plug-in. (Inherited from IShapeFunction.)

Methods

	Name	Description
	Apply	Update a shape from the shape function. (Inherited from IShapeFunction.)
	Defaults	Set a shape function parameters to their default values. (Inherited from IShapeFunction.)
	Init	Initialize to a given shape. (Inherited from IShapeFunction.)
	Initialize	Initialize the plugin. (Inherited from IPlugin.)
	IsCompatible	Return whether a shape function is relevant for a given data type. (Inherited from IShapeFunction.)
	Shape	Returns the actual function data points, as computed from the parameters values. (Inherited from IShapeFunction.)