Detailed Description

Functions
static void	IHChangeBParameter (GlgObject ih, String name, boolean value)
	Changes a boolean value stored in a named parameter. More...

static void	IHChangeDParameter (GlgObject ih, String name, double value)
	Changes a double value stored in a named parameter. More...

static void	IHChangeIParameter (GlgObject ih, String name, int value)
	Changes an integer value stored in a named parameter. More...

static void	IHChangeNParameter (GlgObject ih, String name, Object value)
	Replaces a native object stored in a named parameter. More...

static void	IHChangeOParameter (GlgObject ih, String name, GlgObject value)
	Replaces a GLG object stored in a named parameter. More...

static void	IHChangeSParameter (GlgObject ih, String name, String value)
	Replaces a string stored in a named parameter. More...

static boolean	IHGetBParameter (GlgObject ih, String name)
	Returns a boolean value stored in a named parameter. More...

static double	IHGetDParameter (GlgObject ih, String name)
	Returns a double value stored in a named parameter. More...

static int	IHGetIParameter (GlgObject ih, String name)
	Returns an integer value stored in a named parameter. More...

static Object	IHGetNParameter (GlgObject ih, String name)
	Returns a native object stored in a named parameter. More...

static GlgObject	IHGetOParameter (GlgObject ih, String name)
	Returns a GLG object stored in a named parameter. More...

static boolean	IHGetOptBParameter (GlgObject ih, String name, boolean default_value)
	Returns a boolean value stored in an optional named parameter. More...

static double	IHGetOptDParameter (GlgObject ih, String name, double default_value)
	Returns a double value stored in an optional named parameter. More...

static int	IHGetOptIParameter (GlgObject ih, String name, int default_value)
	Returns an integer value stored in an optional named parameter. More...

static Object	IHGetOptNParameter (GlgObject ih, String name, Object default_value)
	Returns a native object stored in an optional named parameter. More...

static GlgObject	IHGetOptOParameter (GlgObject ih, String name, GlgObject default_value)
	Returns a GLG object stored in an optional named parameter. More...

static String	IHGetOptSParameter (GlgObject ih, String name, String default_value)
	Returns a string stored in an optional named parameter. More...

static String	IHGetSParameter (GlgObject ih, String name)
	Returns a string stored in a named parameter. More...

static void	IHSetBParameter (GlgObject ih, String name, boolean value)
	Creates and stores a named boolean parameter. More...

static void	IHSetDParameter (GlgObject ih, String name, double value)
	Creates and stores a named string parameter. More...

static void	IHSetIParameter (GlgObject ih, String name, int value)
	Creates and stores a named integer parameter. More...

static void	IHSetNParameter (GlgObject ih, String name, Object value)
	Creates and stores a named parameter that holds any native object. More...

static void	IHSetOParameter (GlgObject ih, String name, GlgObject value)
	Creates and stores a named parameter that holds a GLG object. More...

static void	IHSetOParameterFromD (GlgObject ih, String name, double value)
	Creates and stores a named double parameter that is stored as a GLG Data object of the D type. More...

static void	IHSetOParameterFromG (GlgObject ih, String name, double value1, double value2, double value3)
	Creates and stores a named parameter that keeps X, Y and Z or R, G and B values stored as a GLG Data object of the G type. More...

static void	IHSetOParameterFromGPoint (GlgObject ih, String name, GlgPoint point)
	Creates and stores a named parameter that contains geometrical (XYZ) or color (RGB) data and is stored as a GLG Data object of the G type. More...

static void	IHSetSParameter (GlgObject ih, String name, String value)
	Creates and stores a named string parameter. More...

Function Documentation

◆ IHChangeBParameter()

static void IHChangeBParameter	(	GlgObject	ih,
		String	name,
		boolean	value
	)

static

Changes a boolean value stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to change a global parameter.
name	Parameter name.
value	New parameter value.

This method is similar to IHSetBParameter, but instead of creating a new stored parameter, it changes the value of an existing stored parameter of the handler specified by the id.

If the stored parameter with the specified name does not exist, an error is generated.

◆ IHChangeDParameter()

static void IHChangeDParameter	(	GlgObject	ih,
		String	name,
		double	value
	)

static

Changes a double value stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to replace a global parameter.
name	Parameter name.
value	New parameter value.

This method is similar to IHSetDParameter, but instead of creating a new stored parameter, it changes the value of an existing stored parameter of the handler specified by the id.

If the stored parameter with the specified name does not exist, an error is generated.

◆ IHChangeIParameter()

static void IHChangeIParameter	(	GlgObject	ih,
		String	name,
		int	value
	)

static

Changes an integer value stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to change a global parameter.
name	Parameter name.
value	New parameter value.

This method is similar to IHSetIParameter, but instead of creating a new stored parameter, it changes the value of an existing stored parameter of the handler specified by the id.

If the stored parameter with the specified name does not exist, an error is generated.

◆ IHChangeNParameter()

static void IHChangeNParameter	(	GlgObject	ih,
		String	name,
		Object	value
	)

static

Replaces a native object stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to replace a global parameter.
name	Parameter name.
value	New parameter value.

This method is similar to IHSetNParameter, but instead of creating a new stored parameter, it changes the value of an existing stored parameter of the handler specified by the id.

If the stored parameter with the specified name does not exist, an error is generated.

◆ IHChangeOParameter()

static void IHChangeOParameter	(	GlgObject	ih,
		String	name,
		GlgObject	value
	)

static

Replaces a GLG object stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to replace a global parameter.
name	Parameter name.
value	New parameter value.

This method is similar to IHSetOParameter, but instead of creating a new stored parameter, it changes the value of an existing stored parameter of the handler specified by the id.

If the stored parameter with the specified name does not exist, an error is generated.

◆ IHChangeSParameter()

static void IHChangeSParameter	(	GlgObject	ih,
		String	name,
		String	value
	)

static

Replaces a string stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to replace a global parameter.
name	Parameter name.
value	New parameter value.

This method is similar to IHSetSParameter, but instead of creating a new stored parameter, it changes the value of an existing stored parameter of the handler specified by the id.

If the stored parameter with the specified name does not exist, an error is generated.

◆ IHGetBParameter()

static boolean IHGetBParameter	(	GlgObject	ih,
		String	name
	)

static

Returns a boolean value stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.

Returns: Parameter value.

An error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested return type.

◆ IHGetDParameter()

static double IHGetDParameter	(	GlgObject	ih,
		String	name
	)

static

Returns a double value stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.

Returns: Parameter value.

An error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested return type.

◆ IHGetIParameter()

static int IHGetIParameter	(	GlgObject	ih,
		String	name
	)

static

Returns an integer value stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.

Returns: Parameter value.

An error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested return type.

◆ IHGetNParameter()

static Object IHGetNParameter	(	GlgObject	ih,
		String	name
	)

static

Returns a native object stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.

Returns: Parameter value.

An error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested return type.

◆ IHGetOParameter()

static GlgObject IHGetOParameter	(	GlgObject	ih,
		String	name
	)

static

Returns a GLG object stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.

Returns: Parameter value.

An error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested return type.

◆ IHGetOptBParameter()

static boolean IHGetOptBParameter	(	GlgObject	ih,
		String	name,
		boolean	default_value
	)

static

Returns a boolean value stored in an optional named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.
default_value	The default value that will be returned if the named parameter doesn't exist.

Returns: Parameter value or default value.

This method is the same as IHGetBParameter, except that the named parameter is optional. If a stored parameter with the requested name does not exist, a default value provided by default_value is returned.

◆ IHGetOptDParameter()

static double IHGetOptDParameter	(	GlgObject	ih,
		String	name,
		double	default_value
	)

static

Returns a double value stored in an optional named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.
default_value	The default value that will be returned if the named parameter doesn't exist.

Returns: Parameter value or default value.

This method is the same as IHGetDParameter, except that the named parameter is optional. If a stored parameter with the requested name does not exist, a default value provided by default_value is returned.

◆ IHGetOptIParameter()

static int IHGetOptIParameter	(	GlgObject	ih,
		String	name,
		int	default_value
	)

static

Returns an integer value stored in an optional named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.
default_value	The default value that will be returned if the named parameter doesn't exist.

Returns: Parameter value or default value.

This method is the same as IHGetIParameter, except that the named parameter is optional. If a stored parameter with the requested name does not exist, a default value provided by default_value is returned.

◆ IHGetOptNParameter()

static Object IHGetOptNParameter	(	GlgObject	ih,
		String	name,
		Object	default_value
	)

static

Returns a native object stored in an optional named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.
default_value	The default value that will be returned if the named parameter doesn't exist.

Returns: Parameter value or default value.

This method is the same as IHGetNParameter, except that the named parameter is optional. If a stored parameter with the requested name does not exist, a default value provided by default_value is returned.

◆ IHGetOptOParameter()

static GlgObject IHGetOptOParameter	(	GlgObject	ih,
		String	name,
		GlgObject	default_value
	)

static

Returns a GLG object stored in an optional named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.
default_value	The default value that will be returned if the named parameter doesn't exist.

Returns: Parameter value or default value.

This method is the same as IHGetOParameter, except that the named parameter is optional. If a stored parameter with the requested name does not exist, a default value provided by default_value is returned.

◆ IHGetOptSParameter()

static String IHGetOptSParameter	(	GlgObject	ih,
		String	name,
		String	default_value
	)

static

Returns a string stored in an optional named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.
default_value	The default value that will be returned if the named parameter doesn't exist.

Returns: Parameter value or default value.

This method is the same as IHGetSParameter, except that the named parameter is optional. If a stored parameter with the requested name does not exist, a default value provided by default_value is returned.

◆ IHGetSParameter()

static String IHGetSParameter	(	GlgObject	ih,
		String	name
	)

static

Returns a string stored in a named parameter.

Parameters

ih	Handler ID, or IH_GLOBAL to query a global parameter.
name	Parameter name.

Returns: Parameter value.

An error is generated if a requested named parameter does not exist, or if its value cannot be converted to the requested return type.

◆ IHSetBParameter()

static void IHSetBParameter	(	GlgObject	ih,
		String	name,
		boolean	value
	)

static

Creates and stores a named boolean parameter.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query the value of the parameter using IHGetBParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetDParameter()

static void IHSetDParameter	(	GlgObject	ih,
		String	name,
		double	value
	)

static

Creates and stores a named string parameter.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query the value of the parameter using IHGetDParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetIParameter()

static void IHSetIParameter	(	GlgObject	ih,
		String	name,
		int	value
	)

static

Creates and stores a named integer parameter.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query the value of the parameter using IHGetIParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

Using IH Parameters

A parameter is added to the data storage of the handler specified by the ih argument. The following placeholders can also be passed as the ih argument:

IH_NEW can be used to specify the handler after it was created using IHInstall and before it is started with IHStart.
IH_CURR can be used to specify the currently active handler, which can eliminate the need to pass the ih handler ID into all methods the handler may invoke.
IH_GLOBAL object can be used to add parameters to the global data storage instead of the data storage of the current handler.

When a handler is uninstalled, all parameters stored in its data storage are discarded.

◆ IHSetNParameter()

static void IHSetNParameter	(	GlgObject	ih,
		String	name,
		Object	value
	)

static

Creates and stores a named parameter that holds any native object.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query the value of the parameter using IHGetNParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetOParameter()

static void IHSetOParameter	(	GlgObject	ih,
		String	name,
		GlgObject	value
	)

static

Creates and stores a named parameter that holds a GLG object.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query the value of the parameter using IHGetOParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetOParameterFromD()

static void IHSetOParameterFromD	(	GlgObject	ih,
		String	name,
		double	value
	)

static

Creates and stores a named double parameter that is stored as a GLG Data object of the D type.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query parameter value using IHGetDParameter, or to query the stored parameter object using IHGetOParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetOParameterFromG()

static void IHSetOParameterFromG	(	GlgObject	ih,
		String	name,
		double	value1,
		double	value2,
		double	value3
	)

static

Creates and stores a named parameter that keeps X, Y and Z or R, G and B values stored as a GLG Data object of the G type.

Parameters

ih	Handler ID.
name	Parameter name.
value1,value2,value3	Parameter values.

The name argument specifies the name of the parameter; this name can be used to query the stored parameter object using IHGetOParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetOParameterFromGPoint()

static void IHSetOParameterFromGPoint	(	GlgObject	ih,
		String	name,
		GlgPoint	point
	)

static

Creates and stores a named parameter that contains geometrical (XYZ) or color (RGB) data and is stored as a GLG Data object of the G type.

Parameters

ih	Handler ID.
name	Parameter name.
point	A GlgPoint object containing parameter values.

The name argument specifies the name of the parameter; this name can be used to query the stored parameter object using IHGetOParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

◆ IHSetSParameter()

static void IHSetSParameter	(	GlgObject	ih,
		String	name,
		String	value
	)

static

Creates and stores a named string parameter.

Parameters

ih	Handler ID.
name	Parameter name.
value	Parameter value.

The name argument specifies the name of the parameter; this name can be used to query the value of the parameter using IHGetSParameter. If a parameter with the specified name already exists, it will be replaced, which can change the type of the parameter associated with the name.

See the Using IH Parameters section for information on how parameters are used.

Detailed Description

Functions

Function Documentation

◆ IHChangeBParameter()

◆ IHChangeDParameter()

◆ IHChangeIParameter()

◆ IHChangeNParameter()

◆ IHChangeOParameter()

◆ IHChangeSParameter()

◆ IHGetBParameter()

◆ IHGetDParameter()

◆ IHGetIParameter()

◆ IHGetNParameter()

◆ IHGetOParameter()

◆ IHGetOptBParameter()

◆ IHGetOptDParameter()

◆ IHGetOptIParameter()

◆ IHGetOptNParameter()

◆ IHGetOptOParameter()

◆ IHGetOptSParameter()

◆ IHGetSParameter()

◆ IHSetBParameter()

◆ IHSetDParameter()

◆ IHSetIParameter()

◆ IHSetNParameter()

◆ IHSetOParameter()

◆ IHSetOParameterFromD()

◆ IHSetOParameterFromG()

◆ IHSetOParameterFromGPoint()

◆ IHSetSParameter()