Class OdGsView

See

https://docs.opendesign.com/tkernel_api_cpp//OdGsView.html Additional documentation.

Hierarchy (view full)

Constructors

constructor

Methods

add addRef antiAliasingMode backClip background beginInteractivity clearFrozenLayers clientViewInfo clone cloneView comparedTo copyFrom device dolly dolly1 enableAntiAliasing enableDefaultLighting enableSSAO enableStereo endInteractivity erase eraseAll exceededBounds extentsInView fieldHeight fieldWidth flush freezeLayer frontClip getModel getModelList getNumPixelsInUnitSquare getSnapShot getViewport getViewport1 getViewport2 hide initLights interactivityFrameRate invalidate invalidate1 invalidateCachedViewportGeometry isA isBackClipped isEqualTo isFrontClipped isInInteractivity isKindOf isPerspective isStereoEnabled isValid isViewportBorderVisible isVisible lensLength linetypeAlternateScaleMultiplier linetypeScaleMultiplier lineweightToDcScale mode numRefs numRootDrawables objectToDeviceMatrix orbit pan pointInView pointInViewport position projectionMatrix queryX release removeViewport3dClipping removeViewportClipRegion roll rootDrawableAt rootDrawableIdAt screenMatrix select setAlternateLinetypeScaleMultiplier setBackClip setBackground setClearColor setEnableBackClip setEnableFrontClip setFrontClip setLensLength setLinetypeScaleMultiplier setLineweightToDcScale setMode setStereoParameters setUserGiContext setView setViewport setViewport1 setViewport2 setViewport3dClipping setViewportBorderProperties setViewportBorderVisibility setVisualStyle setVisualStyle1 show ssaoMode target thawLayer upVector update userGiContext viewParameters viewingMatrix viewportClipRegion viewportClipRegion1 visualStyle visualStyle1 worldToDeviceMatrix x zoom zoomExtents zoomWindow cast createObject desc pseudoConstructor rxInit rxUninit

Constructors

constructor

Methods

add

  • add(pSceneGraph, pModel): boolean

  • Parameters

    Returns boolean

addRef

antiAliasingMode

  • antiAliasingMode(): number

  • Returns number

backClip

  • backClip(): number

  • Returns number

background

  • background(): OdDbStub

  • Returns OdDbStub

beginInteractivity

  • beginInteractivity(frameRateInHz): number

  • Parameters

    • frameRateInHz: number

    Returns number

clearFrozenLayers

  • clearFrozenLayers(): number

  • Returns number

clientViewInfo

  • clientViewInfo(clientViewInfo): number

  • Parameters

    • clientViewInfo: OdGsClientViewInfo

    Returns number

clone

cloneView

  • cloneView(cloneViewParameters, cloneGeometry): number

  • Parameters

    • cloneViewParameters: boolean
    • cloneGeometry: boolean

    Returns number

comparedTo

copyFrom

device

dolly

  • dolly(dollyVector): number

  • Parameters

    Returns number

dolly1

  • dolly1(xDolly, yDolly, zDolly): number

  • Parameters

    • xDolly: number
    • yDolly: number
    • zDolly: number

    Returns number

enableAntiAliasing

  • enableAntiAliasing(nMode): number

  • Parameters

    • nMode: number

    Returns number

enableDefaultLighting

  • enableDefaultLighting(bEnable, lightType): number

  • Parameters

    Returns number

enableSSAO

  • enableSSAO(bEnable): number

  • Parameters

    • bEnable: boolean

    Returns number

enableStereo

  • enableStereo(enabled): number

  • Parameters

    • enabled: boolean

    Returns number

endInteractivity

  • endInteractivity(): number

  • Returns number

erase

  • erase(sceneGraph): boolean

  • Parameters

    Returns boolean

eraseAll

  • eraseAll(): number

  • Returns number

exceededBounds

  • exceededBounds(): boolean

  • Returns boolean

extentsInView

fieldHeight

  • fieldHeight(): number

  • Returns number

fieldWidth

  • fieldWidth(): number

  • Returns number

flush

  • flush(): number

  • Returns number

freezeLayer

  • freezeLayer(layerID): number

  • Parameters

    • layerID: OdDbStub

    Returns number

frontClip

  • frontClip(): number

  • Returns number

getModel

  • getModel(pDrawable): OdGsModel

  • Parameters

    Returns OdGsModel

getModelList

  • getModelList(): number

  • Returns number

getNumPixelsInUnitSquare

  • getNumPixelsInUnitSquare(point, pixelDensity, bUsePerspective): number

  • Parameters

    Returns number

getSnapShot

  • getSnapShot(pImage, region): number

  • Parameters

    • pImage: OdGiRasterImagePtr
    • region: OdGsDCRect

    Returns number

getViewport

  • getViewport(lowerLeft, upperRight): number

  • Parameters

    Returns number

getViewport1

  • getViewport1(screenRect): number

  • Parameters

    • screenRect: OdGsDCRect

    Returns number

getViewport2

  • getViewport2(screenRect): number

  • Parameters

    • screenRect: OdGsDCRectDouble

    Returns number

hide

  • hide(): number

  • Returns number

initLights

  • initLights(pLightsIterator): number

  • Parameters

    • pLightsIterator: OdRxIterator

    Returns number

interactivityFrameRate

  • interactivityFrameRate(): number

  • Returns number

invalidate

  • invalidate(): number

  • Returns number

invalidate1

  • invalidate1(screenRect): number

  • Parameters

    • screenRect: OdGsDCRect

    Returns number

invalidateCachedViewportGeometry

  • invalidateCachedViewportGeometry(): number

  • Returns number

isA

isBackClipped

  • isBackClipped(): boolean

  • Returns boolean

isEqualTo

isFrontClipped

  • isFrontClipped(): boolean

  • Returns boolean

isInInteractivity

  • isInInteractivity(): boolean

  • Returns boolean

isKindOf

isPerspective

  • isPerspective(): boolean

  • Returns boolean

isStereoEnabled

  • isStereoEnabled(): boolean

  • Returns boolean

isValid

  • isValid(): boolean

  • Returns boolean

isViewportBorderVisible

  • isViewportBorderVisible(): boolean

  • Returns boolean

isVisible

  • isVisible(): boolean

  • Returns boolean

lensLength

  • lensLength(): number

  • Returns number

linetypeAlternateScaleMultiplier

  • linetypeAlternateScaleMultiplier(): number

  • Returns number

linetypeScaleMultiplier

  • linetypeScaleMultiplier(): number

  • Returns number

lineweightToDcScale

  • lineweightToDcScale(): number

  • Returns number

mode

numRefs

numRootDrawables

  • numRootDrawables(): number

  • Returns number

objectToDeviceMatrix

orbit

  • orbit(xOrbit, yOrbit): number

  • Parameters

    • xOrbit: number
    • yOrbit: number

    Returns number

pan

  • pan(xPan, yPan): number

  • Parameters

    • xPan: number
    • yPan: number

    Returns number

pointInView

  • pointInView(pt): boolean

  • Parameters

    Returns boolean

pointInViewport

  • pointInViewport(screenPoint): boolean

  • Parameters

    Returns boolean

position

projectionMatrix

queryX

release

removeViewport3dClipping

  • removeViewport3dClipping(): number

  • Returns number

removeViewportClipRegion

  • removeViewportClipRegion(): number

  • Returns number

roll

  • roll(rollAngle): number

  • Parameters

    • rollAngle: number

    Returns number

rootDrawableAt

  • rootDrawableAt(i, pModelReturn): number

  • Parameters

    • i: number
    • pModelReturn: OdGsModelPtr

    Returns number

rootDrawableIdAt

  • rootDrawableIdAt(i, pModelReturn): OdDbStub

  • Parameters

    • i: number
    • pModelReturn: OdGsModelPtr

    Returns OdDbStub

screenMatrix

select

  • select(pts, nPoints, pReactor, mode): number

  • Parameters

    • pts: OdGsDCPoint
    • nPoints: number
    • pReactor: OdGsSelectionReactor
    • mode: SelectionMode

    Returns number

setAlternateLinetypeScaleMultiplier

  • setAlternateLinetypeScaleMultiplier(linetypeAlternateScaleMultiplier): number

  • Parameters

    • linetypeAlternateScaleMultiplier: number

    Returns number

setBackClip

  • setBackClip(backClip): number

  • Parameters

    • backClip: number

    Returns number

setBackground

  • setBackground(backgroundId): number

  • Parameters

    • backgroundId: OdDbStub

    Returns number

setClearColor

  • setClearColor(color): number

  • Parameters

    Returns number

setEnableBackClip

  • setEnableBackClip(enable): number

  • Parameters

    • enable: boolean

    Returns number

setEnableFrontClip

  • setEnableFrontClip(enable): number

  • Parameters

    • enable: boolean

    Returns number

setFrontClip

  • setFrontClip(frontClip): number

  • Parameters

    • frontClip: number

    Returns number

setLensLength

  • setLensLength(lensLength): number

  • Parameters

    • lensLength: number

    Returns number

setLinetypeScaleMultiplier

  • setLinetypeScaleMultiplier(linetypeScaleMultiplier): number

  • Parameters

    • linetypeScaleMultiplier: number

    Returns number

setLineweightToDcScale

  • setLineweightToDcScale(scale): number

  • Parameters

    • scale: number

    Returns number

setMode

  • setMode(mode): number

  • Parameters

    Returns number

setStereoParameters

  • setStereoParameters(magnitude, parallax): number

  • Parameters

    • magnitude: number
    • parallax: number

    Returns number

setUserGiContext

  • setUserGiContext(pUserGiContext): number

  • Parameters

    • pUserGiContext: OdGiContext

    Returns number

setView

  • setView(position, target, upVector, fieldWidth, fieldHeight, projectionType): number

  • Parameters

    Returns number

setViewport

  • setViewport(lowerLeft, upperRight): number

  • Parameters

    Returns number

setViewport1

  • setViewport1(screenRect): number

  • Parameters

    • screenRect: OdGsDCRect

    Returns number

setViewport2

  • setViewport2(screenRect): number

  • Parameters

    • screenRect: OdGsDCRectDouble

    Returns number

setViewport3dClipping

  • setViewport3dClipping(pBoundary, pClipInfo): number

  • Parameters

    • pBoundary: OdGiClipBoundary
    • pClipInfo: OdGiAbstractClipBoundary

    Returns number

setViewportBorderProperties

  • setViewportBorderProperties(color, width): number

  • Parameters

    • color: number
    • width: number

    Returns number

setViewportBorderVisibility

  • setViewportBorderVisibility(visible): number

  • Parameters

    • visible: boolean

    Returns number

setVisualStyle

  • setVisualStyle(visualStyleId): number

  • Parameters

    • visualStyleId: OdDbStub

    Returns number

setVisualStyle1

  • setVisualStyle1(visualStyle): number

  • Parameters

    • visualStyle: OdGiVisualStyle

    Returns number

show

  • show(): number

  • Returns number

ssaoMode

  • ssaoMode(): boolean

  • Returns boolean

target

thawLayer

  • thawLayer(layerID): number

  • Parameters

    • layerID: OdDbStub

    Returns number

upVector

update

  • update(): number

  • Returns number

userGiContext

  • userGiContext(): OdGiContext

  • Returns OdGiContext

viewParameters

  • viewParameters(pView): number

  • Parameters

    Returns number

viewingMatrix

viewportClipRegion

  • viewportClipRegion(counts, vertices): number

  • Parameters

    • counts: OdIntArray
    • vertices: OdGsDCPointArray

    Returns number

viewportClipRegion1

  • viewportClipRegion1(counts, vertices): number

  • Parameters

    Returns number

visualStyle

  • visualStyle(): OdDbStub

  • Returns OdDbStub

visualStyle1

  • visualStyle1(visualStyle): boolean

  • Parameters

    • visualStyle: OdGiVisualStyle

    Returns boolean

worldToDeviceMatrix

x

zoom

  • zoom(zoomFactor): number

  • Parameters

    • zoomFactor: number

    Returns number

zoomExtents

zoomWindow

  • zoomWindow(lowerLeft, upperRight): number

  • Parameters

    Returns number

Staticcast

StaticcreateObject

Staticdesc

StaticpseudoConstructor

StaticrxInit

StaticrxUninit

Settings

Member Visibility

On This Page

Constructors
Methods
addaddRefantiAliasingModebackClipbackgroundbeginInteractivityclearFrozenLayersclientViewInfoclonecloneViewcomparedTocopyFromdevicedollydolly1enableAntiAliasingenableDefaultLightingenableSSAOenableStereoendInteractivityeraseeraseAllexceededBoundsextentsInViewfieldHeightfieldWidthflushfreezeLayerfrontClipgetModelgetModelListgetNumPixelsInUnitSquaregetSnapShotgetViewportgetViewport1getViewport2hideinitLightsinteractivityFrameRateinvalidateinvalidate1invalidateCachedViewportGeometryisAisBackClippedisEqualToisFrontClippedisInInteractivityisKindOfisPerspectiveisStereoEnabledisValidisViewportBorderVisibleisVisiblelensLengthlinetypeAlternateScaleMultiplierlinetypeScaleMultiplierlineweightToDcScalemodenumRefsnumRootDrawablesobjectToDeviceMatrixorbitpanpointInViewpointInViewportpositionprojectionMatrixqueryXreleaseremoveViewport3dClippingremoveViewportClipRegionrollrootDrawableAtrootDrawableIdAtscreenMatrixselectsetAlternateLinetypeScaleMultipliersetBackClipsetBackgroundsetClearColorsetEnableBackClipsetEnableFrontClipsetFrontClipsetLensLengthsetLinetypeScaleMultipliersetLineweightToDcScalesetModesetStereoParameterssetUserGiContextsetViewsetViewportsetViewport1setViewport2setViewport3dClippingsetViewportBorderPropertiessetViewportBorderVisibilitysetVisualStylesetVisualStyle1showssaoModetargetthawLayerupVectorupdateuserGiContextviewParametersviewingMatrixviewportClipRegionviewportClipRegion1visualStylevisualStyle1worldToDeviceMatrixxzoomzoomExtentszoomWindowcastcreateObjectdescpseudoConstructorrxInitrxUninit