All Frameworks Class Hierarchy This Framework Indexes Previous Next

VisualizationInterfaces Interface CATIVisPropertiesAbstract

Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.

interface CATIVisPropertiesAbstract

Base class for graphic properties interface.
Role: This class defines all methods of .

Method Index

o GetPropertiesAtt(CATVisPropertiesValues&,CATVisPropertyType,CATVisGeomType,unsigned int,int): Retrieves a graphic properties set.
o GetStandardProperties(CATVisPropertiesValues&,CATVisPropertyType,CATVisGeomType): Retrieves standard graphic properties set.
o GetSubTypeFromPath(CATPathElement&,CATVisPropertyType,CATVisGeomType&,unsigned int&): Gives the appropriated geometry type for the Graphic Properties Toolbar.
o IsGeomTypeDefined(CATVisGeomType&): Retrieves if a given geometry type is defined.
o ResetPropertiesAtt(CATVisPropertyType,CATVisGeomType,unsigned int,int): Resets a graphic property.
o SetPropertiesAtt(CATVisPropertiesValues&,CATVisPropertyType,CATVisGeomType,unsigned int,int): Sets a graphic properties set.

Methods

o GetPropertiesAtt

public virtual GetPropertiesAtt(	`ioValues`,
	`iPropertyType`,
	`iGeomType`	`= CATVPGlobalType`,
	`iPropertyNumber`	`= 0`,
	`ifromGetProperties`	`= 0`)

Retrieves a graphic properties set.
Role:This method returns the value set by , or the the value given by , if the graphic properties has not been set or the property has been reseted by

Parameters:

ioValues: The set of graphic properties
iPropertyType: Define the type of property: color, opacity, ... To know the valid property types for a iGeomType see
iGeomType: Define the type of geometry: edge, line, mesh , ...
Default value:CATVPGlobalType.
iPropertyNumber: Parameter not yet used.
Default value:0
ifromSetProperties: Parameter not yet used.
Default value:0

Returns:

Legal values:

S_OK

The operation is OK, and the value is not the standard

S_AUTOMATIC

The operation is OK, and the value is the standard

E_FAIL

Fail's causes:

iGeomType is not defined for the object
The object doesn't implement CATIProperty
iPropertyType is not CATVPShow, CATVPPick or CATVPLayer if iGeomType is CATVPGlobalType
There is no standard value for this property

o GetStandardProperties

public virtual GetStandardProperties(	`ioValues`,
	`iPropertyType`,
	`iGeomType`	`= CATVPGlobalType`)

Retrieves standard graphic properties set.

Parameters:

ioValues: The set of graphic properties
iPropertyType: Define the type of property: color, opacity, ... To know the valid property types for a iGeomType see
iGeomType: Define the type of geometry: edge, line, mesh , ...
Default value:CATVPGlobalType.

Returns:

Legal values:

S_AUTOMATIC

A standard value exists.

E_FAIL

Fail's causes:

iGeomType is not defined for the object
The object doen't implement CATIProperty
iPropertyType is not CATVPShow, CATVPPick or CATVPLayer if iGeomType is CATVPGlobalType
There is no standard value for this property
No standard value exists for this property.

o GetSubTypeFromPath

public virtual GetSubTypeFromPath(		`iPathElement`,
		`iPropertyType`,
		`oGeomType`,
		`oPropertyNumber`)

Gives the appropriated geometry type for the Graphic Properties Toolbar.
Role: Suppose you have selected a Solid. The solid has a color for its edges and a color for faces. In the Edit Properties Command you can affect a color for each composant of your solid. But in the Graphic Properties Toolbar, there is only one combo to choose a color. This method allows you to select the type of geometry in relationship for a given property type.
This method must be mandatory redefined in your own data extension.

Parameters:

iPathElement: Precise the environment of the component. In most case you don't have need of this entry.
iPropertyType: The type of property
oGeomType: Return the geometric type valid for iPropertyType
oPropertyNumber: Return the property number to use. Set 0

Returns:

S_OK

E_FAIL

o IsGeomTypeDefined

public virtual IsGeomTypeDefined( iGeomType)

Retrieves if a given geometry type is defined.
Role This method allows you to know if a given type of geometry is valid for your component.
This method must be mandatory redefined in your own data extension.

Parameters:

iGeomType: The geometric type

Returns:

Legal value:

S_OK: iGeomType is defined for the object.
E_FAIL: iGeomType isn't defined for the object.

o ResetPropertiesAtt

public virtual ResetPropertiesAtt(	`iPropertyType`,
	`iGeomType`	`= CATVPGlobalType`,
	`iPropertyNumber`	`= 0`,
	`ifromResetProperties`	`= 0`)

Resets a graphic property.
Role: The graphic property becomes the standard. see to know the standard value of the graphic property.
The graphic property becomes invalid and so the property becomes unknown for .

Parameters:

iPropertyType: Define the type of property: color, opacity, ... To know the valid property types for a iGeomType see
iGeomType: Define the type of geometry: edge, line, mesh , ...
Default value:CATVPGlobalType.
iPropertyNumber: Parameter not yet used.
Default value:0
ifromSetProperties: Parameter not yet used.
Default value:0

Returns:

Legal values:

S_OK

The operation is OK

E_FAIL

Fail's causes:

iGeomType is not defined for the object
The object doesn't implement CATIProperty
iPropertyType is not CATVPShow, CATVPPick or CATVPLayer if iGeomType is CATVPGlobalType

o SetPropertiesAtt

public virtual SetPropertiesAtt(	`iValues`,
	`iPropertyType`,
	`iGeomType`	`= CATVPGlobalType`,
	`iPropertyNumber`	`= 0`,
	`ifromSetProperties`	`= 0`)

Sets a graphic properties set.
Role: Sets graphic properties on the component.

Parameters:

iValues: The set of graphic properties
iPropertyType: Define the type of property: color, opacity, ... To know the valid property types for iGeomType see
iGeomType: Define the type of geometry: edge, line, mesh , ...
Default value:CATVPGlobalType.
iPropertyNumber: Parameter not yet used.
Default value:0
ifromSetProperties: Parameter not yet used.
Default value:0

Returns:

Legal values:

S_OK

The operation is OK

E_FAIL

iGeomType is not defined for the object
The object doesn't implement CATIProperty
The property iPropertyType of iValues are not set
iPropertyType is not CATVPShow, CATVPPick or CATVPLayer if iGeomType is CATVPGlobalType

This object is included in the file: CATIVisPropertiesAbstract.h
If needed, your Imakefile.mk should include the module: CATVisItf