PoCoordinateSystemAxis

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.fields.SoFieldContainer
    - - com.openinventor.inventor.nodes.SoNode
      - com.openinventor.inventor.nodekits.SoBaseKit
        
        com.openinventor.meshviz.graph.PoBase
        
        com.openinventor.meshviz.graph.PoGraphMaster
        
        com.openinventor.meshviz.graph.PoCoordinateSystemAxis

All Implemented Interfaces:

SafeDisposable
```
public class PoCoordinateSystemAxis
extends PoGraphMaster
```
Class for a 3D axes system. Class to build an axes system. It is composed of three vectors, each having a title string at its extremity. A multiplicative factor translates each title string according to each vector length and another one defines the arrow length of vectors relative to the vector length.
File format/default:
PoCoordinateSystemAxis {
}
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> <link REL="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> <title></title> </head> <BODY> <h1></h1> <h4> <A NAME="Heading499">CATALOG PARTS</A></h4> <ul>PoCoordinateSystemAxis {</ul> <ul><ul>Separator <tt>alternateRep</tt> (from PoBase) { </ul></ul> <ul><ul><ul>AppearanceKit <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Corresponds to the domain transformation.</ul></ul></ul> <ul><ul><ul>PoArrow <tt>xArrow</tt></ul></ul></ul> <ul><ul><ul>Corresponds to the arrow of the x-axis.</ul></ul></ul> <ul><ul><ul>PoArrow <tt>yArrow</tt></ul></ul></ul> <ul><ul><ul>Corresponds to the arrow of the y-axis.</ul></ul></ul> <ul><ul><ul>PoArrow <tt>zArrow</tt></ul></ul></ul> <ul><ul><ul>Corresponds to the arrow of the z-axis.</ul></ul></ul> <ul><ul><ul> Separator <tt>xTitleTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw text of the x-axis.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>xTitleTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of text of the x-axis.</ul></ul></ul></ul> <ul><ul><ul><ul>Group<tt> xTitleText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoText2 shape to draw text of the x-axis.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>yTitleTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw text of the y-axis.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>yTitleTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of text of the y-axis.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>yTitleText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoText2 shape to draw text of the y-axis.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>zTitleTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw text of the z-axis.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>zTitleTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of text of the z-axis.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>zTitleText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoText2 shape to draw the text of the z-axis.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Nested Class Summary
- Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase
  PoBase.NodeWriteFormats, PoBase.TextTypes, PoBase.UpdateMethodTypes
- Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode
  SoNode.RenderModes
- Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
  Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`SoSFFloat`	`arrowLengthFactor` Arrow length scale factor.
`SoSFVec3f`	`end` End of the coordinate system.
`SoSFVec3f`	`start` Start of the coordinate system.
`SoSFFloat`	`titleTranslationFactor` Translation factor of the titles (as function of the length of each vector).
`SoSFString`	`xTitle` String to be displayed at the end of the X coordinate vector.
`SoSFString`	`yTitle` String to be displayed at the end of the Y coordinate vector.
`SoSFString`	`zTitle` String to be displayed at the end of the Z coordinate vector.

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description
`PoCoordinateSystemAxis()` Default constructor.
`PoCoordinateSystemAxis(SbVec3f _start, SbVec3f _end, java.lang.String _xTitle, java.lang.String _yTitle, java.lang.String _zTitle, float _arrowLengthFactor, float _titleTranslationFactor)` Constructor.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static SoNodekitCatalog getClassNodekitCatalog()
Returns the SoNodekitCatalog for this class.
- Methods inherited from class com.openinventor.meshviz.graph.PoBase
  addPostRebuildCallback, addPreRebuildCallback, getDomain, getNodeWriteFormat, getTextType, getUpdateMethod, isBuilt, isModified, isVRML2Mode, rebuild, setDomain, setNodeWriteFormat, setTextType, setUpdateMethod, setVRML2Mode, touchKit
- Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit
  getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren
- Methods inherited from class com.openinventor.inventor.nodes.SoNode
  affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
- Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
  copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, setToDefaults
- Methods inherited from class com.openinventor.inventor.misc.SoBase
  dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
- Methods inherited from class com.openinventor.inventor.Inventor
  getNativeResourceHandle
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.

- Field Detail
  - start
```
public final SoSFVec3f start
```
    Start of the coordinate system. (0,0,0) by default.
  - end
```
public final SoSFVec3f end
```
    End of the coordinate system. (1,1,1) by default.
  - xTitle
```
public final SoSFString xTitle
```
    String to be displayed at the end of the X coordinate vector. "X" by default.
  - yTitle
```
public final SoSFString yTitle
```
    String to be displayed at the end of the Y coordinate vector. "Y" by default.
  - zTitle
```
public final SoSFString zTitle
```
    String to be displayed at the end of the Z coordinate vector. "Z" by default.
  - arrowLengthFactor
```
public final SoSFFloat arrowLengthFactor
```
    Arrow length scale factor. This is the ratio between the length of the arrow and the length of one of the vectors. This value is normally less than 1. 0.05 by default.
  - titleTranslationFactor
```
public final SoSFFloat titleTranslationFactor
```
    Translation factor of the titles (as function of the length of each vector). 0 by default.
- Constructor Detail
  - PoCoordinateSystemAxis
```
public PoCoordinateSystemAxis(SbVec3f _start,
                              SbVec3f _end,
                              java.lang.String _xTitle,
                              java.lang.String _yTitle,
                              java.lang.String _zTitle,
                              float _arrowLengthFactor,
                              float _titleTranslationFactor)
```
    Constructor.
  - PoCoordinateSystemAxis
```
public PoCoordinateSystemAxis()
```
    Default constructor.
- Method Detail
  - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
    Returns the SoNodekitCatalog for this class.

start	0 0 0
end	1 1 1
xTitle	"X"
yTitle	"Y"
zTitle	"Z"
arrowLengthFactor	0.05
titleTranslationFactor	0

Class PoCoordinateSystemAxis

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.meshviz.graph.PoBase

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Methods inherited from class com.openinventor.inventor.nodes.SoNode

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

start

end

xTitle

yTitle

zTitle

arrowLengthFactor

titleTranslationFactor

Constructor Detail

PoCoordinateSystemAxis

PoCoordinateSystemAxis

Method Detail

getClassNodekitCatalog