PsJavaView ("JavaView Reference Manual")

java.lang.Object
- jv.object.PsObject
- - jv.rsrc.PsJavaView

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, PsUpdateIf
```
public final class PsJavaView
extends PsObject
```
All JavaView resource information for configuration of the system.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FILE_BUG` Bug repository directory.
`static int`	`FILE_CODEBASE` Codebase directory type is the installation directory of JavaView.
`static int`	`FILE_GEOMETRY` Name of recent geometry file or directory.
`static int`	`FILE_IMAGE` Name of recent image file or directory.
`static int`	`FILE_LICENSE` License directory type identifies location of a license file.
`static int`	`FILE_LOADERS` Name of package such as devXY.loader where system searches for additional loader classes such as devXY.loader.PgAbcLoader.
`static int`	`FILE_MENU` Names of menu packages such as dev.geom, additional entries must be comma separated.
`static int`	`FILE_MODELS` Directory for model collection.
`static int`	`FILE_RESOURCE` Resource directory type identifies the location of user profile.
`static int`	`FILE_VALIDATE` Validation repository directory.
`static int`	`FILE_WORKING` Working directory type is used for import and export of files.
`static boolean`	`m_bAutoIdentify` Determines if automatic identification of vertices is enabled during file import.
`static boolean`	`m_bAutoNeighbour` Determines if neighbour information is automatically computed during file import.
`static boolean`	`m_bAutoNormals` Determines if normal vectors are automatically computed during file import.
`static boolean`	`m_bConsoleUsable`
`static boolean`	`m_bControlUsable`
`static boolean`	`m_bFastClipping` Determines if fast clipping is performed during rendering.
`static boolean`	`m_bFilterVertices` Determines if only every 100th vertex is loaded, requires m_bOnlyVertices==true.
`static boolean`	`m_bInstanceSharing` Determines if a geometry and its PvGeometry display container may share instance variables.
`static boolean`	`m_bOnlyVertices` Determines if only vertices of a geometry are loaded.
`static java.lang.String`	`m_consoleVisible`
`static java.lang.String`	`m_controlVisible`
`static java.lang.String`	`m_monitorMouse` Monitor type determines the monitor mouse.
`static int`	`m_monitorType` Monitor type determines the monitor screen.
`static java.lang.String`	`m_viewerScreen`
`static java.lang.String`	`m_viewerVisible`
`static int`	`MONITOR` Identifier of control window.
`static int`	`MONITOR_QVGA` Monitor size is 320*240.
`static int`	`MONITOR_SVGA` Monitor size is 800*600.
`static int`	`MONITOR_SXGA` Monitor size is 1280*1024.
`static int`	`MONITOR_USER` Monitor size is user-defined.
`static int`	`MONITOR_UXGA` Monitor size is 1600*1200.
`static int`	`MONITOR_VGA` Monitor size is 640*480.
`static int`	`MONITOR_XGA` Monitor size is 1024*768.
`static int`	`WINDOW_ABOUT` Identifier of about window.
`static int`	`WINDOW_ANIMATION` Identifier of animation dialog.
`static int`	`WINDOW_CONSOLE` Identifier of JavaView console.
`static int`	`WINDOW_CONTROL` Identifier of control window.
`static int`	`WINDOW_EXPORT_MODEL` Identifier of export window.
`static int`	`WINDOW_HELP` Identifier of help window.
`static int`	`WINDOW_IMPORT_MODEL` Identifier of import window.
`static int`	`WINDOW_NEW_PROJECT` Identifier of new project window.

Fields inherited from class jv.object.PsObject
HAS_BOUNDARY_PANEL, HAS_CONFIG_PANEL, HAS_INFO_PANEL, HAS_LABEL_PANEL, HAS_MATERIAL_PANEL, HAS_TEXTURE_PANEL, HAS_VECTOR_PANEL, INSPECTOR_INFO, INSPECTOR_INFO_EXT, IS_DELETED, IS_FIXED, IS_FOCUSSED, IS_PICKED, IS_SELECTED, IS_USED, NUM_TAGS

Constructor Summary

Constructors
Constructor and Description

PsJavaView()

Constructors
Constructor and Description
`PsJavaView()`

Method Summary

Methods
Modifier and Type	Method and Description
`static PsAuthorInfo`	`getAuthorInfo()` Get information about current user of JavaView.
`static java.lang.String`	`getDirectory(int type)` Get special directories of JavaView, for example, the PsJavaView#FILE_WORKING which is suggested when exporting geometries.
`static java.lang.String`	`getFileName(int type)` Get special fileName of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
`static java.lang.String`	`getFullFileName(int type)` Get special fileName and path of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
`java.lang.String`	`getTitle()` Get the title of the resource description.
`static int[]`	`getWindowSize(int windowId)` Get position and size of a window.
`static PsXmlSrc`	`getXml()` Fills an XML tree with data from this instance, for example, to print to file.
`static boolean`	`isEnabledWorkshopBackup()` Determines if backup copies of geometries are created when a workshop is opened.
`static boolean`	`read(java.lang.String rsrcFile)` Read an XML file and create a tree structure of instances of type `PsXmlNode`.
`static void`	`setAuthorInfo(PsAuthorInfo info)` Set author information by copying or cloning the argument author info.
`static void`	`setDirectory(int type, java.lang.String dir)` Set special directories of JavaView, for example, the directory type PsJavaView#FILE_WORKING identifies a location which is suggested when exporting geometries.
`static void`	`setEnabledWorkshopBackup(boolean flag)` Determines if backup copies of geometries are created when a workshop is opened.
`static void`	`setFileName(int type, java.lang.String fileName)` Set special fileName of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
`static void`	`setFullFileName(int type, java.lang.String fullFileName)` Set special fileName and path of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
`void`	`setTitle(java.lang.String title)` Set the title of the resource description.
`static void`	`setXml(PsXmlSrc src)` Fill this instance with data from an XML source, for example, previously read from file.
`static boolean`	`write(java.lang.String rsrcFile)` Write an XML file and create a tree structure of instances of type `PsXmlNode`.

Methods inherited from class jv.object.PsObject
addInspector, addUpdateListener, assureInspector, clearTag, clone, clone, clone, copy, getFather, getInfoPanel, getInspector, getName, getNumObjects, getSymbol, hasInspector, hasTag, hasUpdateListener, init, instanceOf, instanceOf, newInspector, newInspector, removeInspector, removeInspector, removeUpdateListener, setName, setParent, setSymbol, setTag, toString, update, updatePanels

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FILE_CODEBASE
```
public static final int FILE_CODEBASE
```
    Codebase directory type is the installation directory of JavaView.
    
    See Also:
    Constant Field Values
  - FILE_LICENSE
```
public static final int FILE_LICENSE
```
    License directory type identifies location of a license file.
    
    See Also:
    Constant Field Values
  - FILE_RESOURCE
```
public static final int FILE_RESOURCE
```
    Resource directory type identifies the location of user profile.
    
    See Also:
    Constant Field Values
  - FILE_WORKING
```
public static final int FILE_WORKING
```
    Working directory type is used for import and export of files.
    
    See Also:
    Constant Field Values
  - FILE_MODELS
```
public static final int FILE_MODELS
```
    Directory for model collection.
    
    See Also:
    Constant Field Values
  - FILE_BUG
```
public static final int FILE_BUG
```
    Bug repository directory.
    
    See Also:
    Constant Field Values
  - FILE_VALIDATE
```
public static final int FILE_VALIDATE
```
    Validation repository directory.
    
    See Also:
    Constant Field Values
  - FILE_GEOMETRY
```
public static final int FILE_GEOMETRY
```
    Name of recent geometry file or directory.
    
    See Also:
    Constant Field Values
  - FILE_IMAGE
```
public static final int FILE_IMAGE
```
    Name of recent image file or directory.
    
    See Also:
    Constant Field Values
  - FILE_LOADERS
```
public static final int FILE_LOADERS
```
    Name of package such as devXY.loader where system searches for additional loader classes such as devXY.loader.PgAbcLoader. The loader PgAbcLoader is then used to load geometry files in the Abc format, such as myShape.abc with filename extension abc.
    
    Since:
    
    JavaView 3.99.073
    
    See Also:
    Constant Field Values
  - FILE_MENU
```
public static final int FILE_MENU
```
    Names of menu packages such as dev.geom, additional entries must be comma separated. JavaView then searches for menu classes such as dev.geom.[GeometryClass]_menu.class where GeometryClass the base name of the currently selected geometry class is.
    
    See Also:
    Constant Field Values
  - MONITOR_UXGA
```
public static final int MONITOR_UXGA
```
    Monitor size is 1600*1200.
    
    See Also:
    Constant Field Values
  - MONITOR_SXGA
```
public static final int MONITOR_SXGA
```
    Monitor size is 1280*1024.
    
    See Also:
    Constant Field Values
  - MONITOR_XGA
```
public static final int MONITOR_XGA
```
    Monitor size is 1024*768.
    
    See Also:
    Constant Field Values
  - MONITOR_SVGA
```
public static final int MONITOR_SVGA
```
    Monitor size is 800*600.
    
    See Also:
    Constant Field Values
  - MONITOR_VGA
```
public static final int MONITOR_VGA
```
    Monitor size is 640*480.
    
    See Also:
    Constant Field Values
  - MONITOR_QVGA
```
public static final int MONITOR_QVGA
```
    Monitor size is 320*240.
    
    See Also:
    Constant Field Values
  - MONITOR_USER
```
public static final int MONITOR_USER
```
    Monitor size is user-defined.
    
    See Also:
    Constant Field Values
  - MONITOR
```
public static final int MONITOR
```
    Identifier of control window.
    
    See Also:
    Constant Field Values
  - WINDOW_CONTROL
```
public static final int WINDOW_CONTROL
```
    Identifier of control window.
    
    See Also:
    Constant Field Values
  - WINDOW_ABOUT
```
public static final int WINDOW_ABOUT
```
    Identifier of about window.
    
    See Also:
    Constant Field Values
  - WINDOW_HELP
```
public static final int WINDOW_HELP
```
    Identifier of help window.
    
    See Also:
    Constant Field Values
  - WINDOW_CONSOLE
```
public static final int WINDOW_CONSOLE
```
    Identifier of JavaView console.
    
    See Also:
    Constant Field Values
  - WINDOW_ANIMATION
```
public static final int WINDOW_ANIMATION
```
    Identifier of animation dialog.
    
    See Also:
    Constant Field Values
  - WINDOW_NEW_PROJECT
```
public static final int WINDOW_NEW_PROJECT
```
    Identifier of new project window.
    
    See Also:
    Constant Field Values
  - WINDOW_IMPORT_MODEL
```
public static final int WINDOW_IMPORT_MODEL
```
    Identifier of import window.
    
    See Also:
    Constant Field Values
  - WINDOW_EXPORT_MODEL
```
public static final int WINDOW_EXPORT_MODEL
```
    Identifier of export window.
    
    See Also:
    Constant Field Values
  - m_bAutoIdentify
```
public static boolean m_bAutoIdentify
```
    Determines if automatic identification of vertices is enabled during file import.
  - m_bAutoNeighbour
```
public static boolean m_bAutoNeighbour
```
    Determines if neighbour information is automatically computed during file import.
  - m_bAutoNormals
```
public static boolean m_bAutoNormals
```
    Determines if normal vectors are automatically computed during file import.
  - m_bInstanceSharing
```
public static boolean m_bInstanceSharing
```
    Determines if a geometry and its PvGeometry display container may share instance variables.
  - m_bOnlyVertices
```
public static boolean m_bOnlyVertices
```
    Determines if only vertices of a geometry are loaded.
  - m_bFilterVertices
```
public static boolean m_bFilterVertices
```
    Determines if only every 100th vertex is loaded, requires m_bOnlyVertices==true.
  - m_bFastClipping
```
public static boolean m_bFastClipping
```
    Determines if fast clipping is performed during rendering.
  - m_monitorType
```
public static int m_monitorType
```
    Monitor type determines the monitor screen.
  - m_monitorMouse
```
public static java.lang.String m_monitorMouse
```
    Monitor type determines the monitor mouse.
  - m_viewerScreen
```
public static java.lang.String m_viewerScreen
```
  - m_viewerVisible
```
public static java.lang.String m_viewerVisible
```
  - m_controlVisible
```
public static java.lang.String m_controlVisible
```
  - m_bControlUsable
```
public static boolean m_bControlUsable
```
  - m_consoleVisible
```
public static java.lang.String m_consoleVisible
```
  - m_bConsoleUsable
```
public static boolean m_bConsoleUsable
```
- Constructor Detail
  - PsJavaView
```
public PsJavaView()
```
- Method Detail
  - isEnabledWorkshopBackup
```
public static boolean isEnabledWorkshopBackup()
```
    Determines if backup copies of geometries are created when a workshop is opened.
    
    Since:
    
    JavaView 3.09.003
  - setEnabledWorkshopBackup
```
public static void setEnabledWorkshopBackup(boolean flag)
```
    Determines if backup copies of geometries are created when a workshop is opened. By default, backup copies of geometries are created when a workshop is opened. This provides an UNDO feature to restore the original geometry when a user cancels the workshop.
    
    Since:
    
    JavaView 3.09.003
  - getTitle
```
public java.lang.String getTitle()
```
    Get the title of the resource description.
    
    See Also:
    setTitle(String)
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Set the title of the resource description.
    
    See Also:
    getTitle()
  - getDirectory
```
public static java.lang.String getDirectory(int type)
```
    Get special directories of JavaView, for example, the PsJavaView#FILE_WORKING which is suggested when exporting geometries. A user may specify different directory types in his JavaView resource file *.jvr.
    By default the working directory is the codeBase.
    
    Since:
    
    JavaView 2.89.000
    
    See Also:
    setDirectory(int, String)
  - setDirectory
```
public static void setDirectory(int type,
                java.lang.String dir)
```
    Set special directories of JavaView, for example, the directory type PsJavaView#FILE_WORKING identifies a location which is suggested when exporting geometries. A user may specify different directory types in his JavaView resource file *.jvr.
    By default the working directory is the codeBase.
    
    Since:
    
    JavaView 2.89.000
    
    See Also:
    getDirectory(int)
  - getFileName
```
public static java.lang.String getFileName(int type)
```
    Get special fileName of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
    
    Since:
    
    JavaView 3.09.003
    
    See Also:
    setFileName(int, String)
  - setFileName
```
public static void setFileName(int type,
               java.lang.String fileName)
```
    Set special fileName of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
    
    Since:
    
    JavaView 3.09.003
    
    See Also:
    getFileName(int)
  - getFullFileName
```
public static java.lang.String getFullFileName(int type)
```
    Get special fileName and path of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
    
    Since:
    
    JavaView 3.09.003
    
    See Also:
    setFullFileName(int, String)
  - setFullFileName
```
public static void setFullFileName(int type,
                   java.lang.String fullFileName)
```
    Set special fileName and path of JavaView, for example, the file type PsJavaView#FILE_RESOURCE identifies a resource file for user preferences.
    
    Since:
    
    JavaView 3.09.003
    
    See Also:
    getFullFileName(int)
  - getAuthorInfo
```
public static PsAuthorInfo getAuthorInfo()
```
    Get information about current user of JavaView.
  - setAuthorInfo
```
public static void setAuthorInfo(PsAuthorInfo info)
```
    Set author information by copying or cloning the argument author info. If argument is null then global author information is removed.
  - read
```
public static boolean read(java.lang.String rsrcFile)
```
    Read an XML file and create a tree structure of instances of type PsXmlNode.
    
    Parameters:
    rsrcFile - full name of resource file
    
    Returns:
    true if loading was successful
  - write
```
public static boolean write(java.lang.String rsrcFile)
```
    Write an XML file and create a tree structure of instances of type PsXmlNode.
    
    Parameters:
    rsrcFile - full name of resource file
    
    Returns:
    true if loading was successful
  - getXml
```
public static PsXmlSrc getXml()
```
    Fills an XML tree with data from this instance, for example, to print to file.
    
    Returns:
    XML tree filled with data from this instance.
  - setXml
```
public static void setXml(PsXmlSrc src)
```
    Fill this instance with data from an XML source, for example, previously read from file.
    
    Parameters:
    src - XML source used to fill this instance with data.
  - getWindowSize
```
public static int[] getWindowSize(int windowId)
```
    Get position and size of a window.
    
    Parameters:
    windowId - Identifier of window as specified in PsJavaView, e.g. WINDOW_CONTROL.
    
    Returns:
    int[4] vector with x and y position and height and width of window.

Class PsJavaView

Field Summary

Fields inherited from class jv.object.PsObject

Constructor Summary

Method Summary

Methods inherited from class jv.object.PsObject

Methods inherited from class java.lang.Object

Field Detail

FILE_CODEBASE

FILE_LICENSE

FILE_RESOURCE

FILE_WORKING

FILE_MODELS

FILE_BUG

FILE_VALIDATE

FILE_GEOMETRY

FILE_IMAGE

FILE_LOADERS

FILE_MENU

MONITOR_UXGA

MONITOR_SXGA

MONITOR_XGA

MONITOR_SVGA

MONITOR_VGA

MONITOR_QVGA

MONITOR_USER

MONITOR

WINDOW_CONTROL

WINDOW_ABOUT

WINDOW_HELP

WINDOW_CONSOLE

WINDOW_ANIMATION

WINDOW_NEW_PROJECT

WINDOW_IMPORT_MODEL

WINDOW_EXPORT_MODEL

m_bAutoIdentify

m_bAutoNeighbour

m_bAutoNormals

m_bInstanceSharing

m_bOnlyVertices

m_bFilterVertices

m_bFastClipping

m_monitorType

m_monitorMouse

m_viewerScreen

m_viewerVisible

m_controlVisible

m_bControlUsable

m_consoleVisible

m_bConsoleUsable

Constructor Detail

PsJavaView

Method Detail

isEnabledWorkshopBackup

setEnabledWorkshopBackup

getTitle

setTitle

getDirectory

setDirectory

getFileName

setFileName

getFullFileName

setFullFileName

getAuthorInfo

setAuthorInfo

read

write

getXml

setXml

getWindowSize