| SoToHTMLAction Class |
Generates an HTML image map and an image from a scene graph.
Inheritance HierarchyNamespace: OIV.Inventor.Actions
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoToHTMLAction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoToHTMLAction | Constructor. |
Methods| Name | Description | |
|---|---|---|
| Apply(SoNode) | Generate HTML output for the specified root node. |
| Apply(SoPath) | Generate HTML output for the specified path. |
| Apply(SoPathList) | Calls Apply(pathList, false). |
| Apply(SoPathList, Boolean) | Generate HTML output for the specified list of path. |
| ClearApplyResult | When applied, an action may reference nodes or create objects (e.g. |
| CloseHTMLFile | Closes the HTML output file. |
 | EnableElement | |
| EnableElements | (Overrides SoActionEnableElements.) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| ForwardTraversal(SoNode) | Traverse a node that is not part of the current scenegraph. |
| ForwardTraversal(SoPath) | Traverse a path that is not part of the current scenegraph. |
| GetContinueActionInBranchFlag | This function indicates if the action must stop in the current branch. |
| GetCurPath | Returns the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed. |
| GetDistribMode | Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only). |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetImageBackgroundColor | Returns the image background color. |
| GetImageComponents | Returns the components of image. |
| GetImageFormat | Returns the image format. |
| GetImageQuality | Returns the image quality. |
| GetImageURLName | Returns the URL name of image in the HTML file. |
| GetNodeAppliedTo | Returns the node the action is being applied to. |
| GetOriginalPathListAppliedTo | Returns the original path list the action is being applied to. |
| GetPathAppliedTo | Returns the path the action is being applied to. |
| GetPathCode | Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to. |
| GetPathListAppliedTo | Returns the path list the action is being applied to. |
| GetPipeId | Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| GetRegionShapeType | Returns the region shape type. |
| GetSceneManager | Return the OIV.Inventor.SoSceneManager associated with this action. |
| GetState | Gets the state from the action. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetViewportRegion | Returns viewport region for the image. |
| GetWhatAppliedTo | Returns code indicating what action is being applied to. |
| HasTerminated | Returns true if the traversal has reached a termination condition. |
| InvalidateState | Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. |
| IsBeingApplied | Returns true if this action is currently being applied. |
| IsLastPathListAppliedTo | Returns true if the current list is the last one from the original. |
| IsMapHighlight | Returns anchor highlighting. |
| IsUsingAlternateRep | Returns true if current action is using alternate representations. |
| OpenHTMLFile | Opens named file. |
| PostDelayedTraversal | Method called by SoMultiPassManager after delayed pass traversals. |
| PreDelayedTraversal | Method called by SoMultiPassManager before delayed pass traversals. |
| ResetContinueActionInBranchFlag | This function resets the continue action flag. |
| ResetHTMLBuffer | Resets buffer of the HTML output for output again. |
| SetImageBackgroundColor | Sets the image background color. |
| SetImageComponents | Sets the components of image. |
| SetImageFormat | Sets the image format. |
| SetImageQuality | Sets the image quality. |
| SetImageURLName | Sets the URL name of image in the HTML file, ("image.jpg" by default). |
| SetMapHighlight | Sets anchor highlighting. |
| SetPipeId | Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| SetRegionShapeType | Sets the region shape type. |
| SetSceneManager | Set the scene manager associated with this action (if any ). |
| SetUpState | Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created. |
| SetViewportRegion | Specifies viewport region for the image. |
| StopActionInBranch | This function stops the action in the current Scene Graph branch. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Traverse | Does traversal of a graph rooted by a node. |
| UseAlternateRep | Tell the action to use alternate representations during traversal when available. |
RemarksThis action generates an image file and an HTML file containing the image (<IMG>) and image map (<MAP>) tags. Each region of the image map will have a URL associated with it.
With HTML, image maps allow to specify regions of an image and assign a specific action to each region (a link can be associated to each map). When the region is activated by the user, the action is executed.
Each region of the image is determined by a subgraph which is under an OIV.Inventor.Nodes.SoWWWAnchor group node.
The HTML file generated contains, in the following order:
An image map tag that defines the regions (maps) corresponding to each subgraph that is under an OIV.Inventor.Nodes.SoWWWAnchor group node.
For each region, the associated link is the URL defined either by the OIV.Inventor.Nodes.SoWWWAnchor node.
An image tag that references the image generated by OIV.Inventor.Actions.SoToHTMLAction.
See Also