Class OdGsView

See

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

Hierarchy (view full)

OdRxObject
- OdGsView

Index

Constructors

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 getStereoParameters getViewport getViewport1 getViewport2 getViewportBorderProperties 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 setViewportClipRegion setViewportClipRegion1 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

new OdGsView(): OdGsView
Returns OdGsView
Inherited from OdRxObject.constructor

Methods

add

add(pSceneGraph, pModel): boolean
Parameters
- pSceneGraph: OdGiDrawable
- pModel: OdGsModel
Returns boolean

addRef

addRef(): void
Returns void
Inherited from OdRxObject.addRef

antiAliasingMode

antiAliasingMode(): number
Returns number

backClip

backClip(): number
Returns number

background

background(): OdDbStub
Returns OdDbStub

beginInteractivity

beginInteractivity(frameRateInHz): void
Parameters
- frameRateInHz: number
Returns void

clearFrozenLayers

clearFrozenLayers(): void
Returns void

clientViewInfo

clientViewInfo(clientViewInfo): void
Parameters
- clientViewInfo: OdGsClientViewInfo
Returns void

clone

clone(): OdRxObjectPtr
Returns OdRxObjectPtr
Inherited from OdRxObject.clone

cloneView

cloneView(cloneViewParameters, cloneGeometry): OdGsView
Parameters
- cloneViewParameters: boolean
- cloneGeometry: boolean
Returns OdGsView

comparedTo

comparedTo(pOther): Ordering
Parameters
- pOther: OdRxObject
Returns Ordering
Inherited from OdRxObject.comparedTo

copyFrom

copyFrom(pSource): void
Parameters
- pSource: OdRxObject
Returns void
Inherited from OdRxObject.copyFrom

device

device(): OdGsDevice
Returns OdGsDevice

dolly

dolly(dollyVector): void
Parameters
- dollyVector: OdGeVector3d
Returns void

dolly1

dolly1(xDolly, yDolly, zDolly): void
Parameters
- xDolly: number
- yDolly: number
- zDolly: number
Returns void

enableAntiAliasing

enableAntiAliasing(nMode): void
Parameters
- nMode: number
Returns void

enableDefaultLighting

enableDefaultLighting(bEnable, lightType): void
Parameters
- bEnable: boolean
- lightType: DefaultLightingType
Returns void

enableSSAO

enableSSAO(bEnable): void
Parameters
- bEnable: boolean
Returns void

enableStereo

enableStereo(enabled): void
Parameters
- enabled: boolean
Returns void

endInteractivity

endInteractivity(): void
Returns void

erase

erase(sceneGraph): boolean
Parameters
- sceneGraph: OdGiDrawable
Returns boolean

eraseAll

eraseAll(): void
Returns void

exceededBounds

exceededBounds(): boolean
Returns boolean

extentsInView

extentsInView(minPt, maxPt): boolean
Parameters
- minPt: OdGePoint3d
- maxPt: OdGePoint3d
Returns boolean

fieldHeight

fieldHeight(): number
Returns number

fieldWidth

fieldWidth(): number
Returns number

flush

flush(): void
Returns void

freezeLayer

freezeLayer(layerID): void
Parameters
- layerID: OdDbStub
Returns void

frontClip

frontClip(): number
Returns number

getModel

getModel(pDrawable): OdGsModel
Parameters
- pDrawable: OdGiDrawable
Returns OdGsModel

getModelList

getModelList(): OdGsModelArray
Returns OdGsModelArray

getNumPixelsInUnitSquare

getNumPixelsInUnitSquare(point, pixelDensity, bUsePerspective): void
Parameters
- point: OdGePoint3d
- pixelDensity: OdGePoint2d
- bUsePerspective: boolean
Returns void

getSnapShot

getSnapShot(pImage, region): void
Parameters
- pImage: OdGiRasterImage
- region: OdGsDCRect
Returns void

getStereoParameters

getStereoParameters(magnitude, parallax): void
Parameters
- magnitude: number
- parallax: number
Returns void

getViewport

getViewport(lowerLeft, upperRight): void
Parameters
- lowerLeft: OdGePoint2d
- upperRight: OdGePoint2d
Returns void

getViewport1

getViewport1(screenRect): void
Parameters
- screenRect: OdGsDCRect
Returns void

getViewport2

getViewport2(screenRect): void
Parameters
- screenRect: OdGsDCRectDouble
Returns void

getViewportBorderProperties

getViewportBorderProperties(color, width): void
Parameters
- color: number
- width: number
Returns void

hide

hide(): void
Returns void

initLights

initLights(pLightsIterator): void
Parameters
- pLightsIterator: OdRxIterator
Returns void

interactivityFrameRate

interactivityFrameRate(): number
Returns number

invalidate

invalidate(): void
Returns void

invalidate1

invalidate1(screenRect): void
Parameters
- screenRect: OdGsDCRect
Returns void

invalidateCachedViewportGeometry

invalidateCachedViewportGeometry(): void
Returns void

isA

isA(): OdRxClass
Returns OdRxClass
Overrides OdRxObject.isA

isBackClipped

isBackClipped(): boolean
Returns boolean

isEqualTo

isEqualTo(pOther): boolean
Parameters
- pOther: OdRxObject
Returns boolean
Inherited from OdRxObject.isEqualTo

isFrontClipped

isFrontClipped(): boolean
Returns boolean

isInInteractivity

isInInteractivity(): boolean
Returns boolean

isKindOf

isKindOf(pClass): boolean
Parameters
- pClass: OdRxClass
Returns boolean
Inherited from OdRxObject.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

mode(): RenderMode
Returns RenderMode

numRefs

numRefs(): number
Returns number
Inherited from OdRxObject.numRefs

numRootDrawables

numRootDrawables(): number
Returns number

objectToDeviceMatrix

objectToDeviceMatrix(): OdGeMatrix3d
Returns OdGeMatrix3d

orbit

orbit(xOrbit, yOrbit): void
Parameters
- xOrbit: number
- yOrbit: number
Returns void

pan

pan(xPan, yPan): void
Parameters
- xPan: number
- yPan: number
Returns void

pointInView

pointInView(pt): boolean
Parameters
- pt: OdGePoint3d
Returns boolean

pointInViewport

pointInViewport(screenPoint): boolean
Parameters
- screenPoint: OdGePoint2d
Returns boolean

position

position(): OdGePoint3d
Returns OdGePoint3d

projectionMatrix

projectionMatrix(): OdGeMatrix3d
Returns OdGeMatrix3d

queryX

queryX(protocolClass): OdRxObject
Parameters
- protocolClass: OdRxClass
Returns OdRxObject
Overrides OdRxObject.queryX

release

release(): void
Returns void
Inherited from OdRxObject.release

removeViewport3dClipping

removeViewport3dClipping(): void
Returns void

removeViewportClipRegion

removeViewportClipRegion(): void
Returns void

roll

roll(rollAngle): void
Parameters
- rollAngle: number
Returns void

rootDrawableAt

rootDrawableAt(i, pModelReturn): OdGiDrawable
Parameters
- i: number
- pModelReturn: OdGsModel
Returns OdGiDrawable

rootDrawableIdAt

rootDrawableIdAt(i, pModelReturn): OdDbStub
Parameters
- i: number
- pModelReturn: OdGsModel
Returns OdDbStub

screenMatrix

screenMatrix(): OdGeMatrix3d
Returns OdGeMatrix3d

select

select(pts, nPoints, pReactor, mode): void
Parameters
- pts: OdGsDCPoint
- nPoints: number
- pReactor: OdGsSelectionReactor
- mode: SelectionMode
Returns void

setAlternateLinetypeScaleMultiplier

setAlternateLinetypeScaleMultiplier(linetypeAlternateScaleMultiplier): void
Parameters
- linetypeAlternateScaleMultiplier: number
Returns void

setBackClip

setBackClip(backClip): void
Parameters
- backClip: number
Returns void

setBackground

setBackground(backgroundId): void
Parameters
- backgroundId: OdDbStub
Returns void

setClearColor

setClearColor(color): void
Parameters
- color: ClearColor
Returns void

setEnableBackClip

setEnableBackClip(enable): void
Parameters
- enable: boolean
Returns void

setEnableFrontClip

setEnableFrontClip(enable): void
Parameters
- enable: boolean
Returns void

setFrontClip

setFrontClip(frontClip): void
Parameters
- frontClip: number
Returns void

setLensLength

setLensLength(lensLength): void
Parameters
- lensLength: number
Returns void

setLinetypeScaleMultiplier

setLinetypeScaleMultiplier(linetypeScaleMultiplier): void
Parameters
- linetypeScaleMultiplier: number
Returns void

setLineweightToDcScale

setLineweightToDcScale(scale): void
Parameters
- scale: number
Returns void

setMode

setMode(mode): void
Parameters
- mode: RenderMode
Returns void

setStereoParameters

setStereoParameters(magnitude, parallax): void
Parameters
- magnitude: number
- parallax: number
Returns void

setUserGiContext

setUserGiContext(pUserGiContext): void
Parameters
- pUserGiContext: OdGiContext
Returns void

setView

setView(position, target, upVector, fieldWidth, fieldHeight, projectionType): void
Parameters
- position: OdGePoint3d
- target: OdGePoint3d
- upVector: OdGeVector3d
- fieldWidth: number
- fieldHeight: number
- projectionType: Projection
Returns void

setViewport

setViewport(lowerLeft, upperRight): void
Parameters
- lowerLeft: OdGePoint2d
- upperRight: OdGePoint2d
Returns void

setViewport1

setViewport1(screenRect): void
Parameters
- screenRect: OdGsDCRect
Returns void

setViewport2

setViewport2(screenRect): void
Parameters
- screenRect: OdGsDCRectDouble
Returns void

setViewport3dClipping

setViewport3dClipping(pBoundary, pClipInfo): void
Parameters
- pBoundary: OdGiClipBoundary
- pClipInfo: OdGiAbstractClipBoundary
Returns void

setViewportBorderProperties

setViewportBorderProperties(color, width): void
Parameters
- color: number
- width: number
Returns void

setViewportBorderVisibility

setViewportBorderVisibility(visible): void
Parameters
- visible: boolean
Returns void

setViewportClipRegion

setViewportClipRegion(numContours, numVertices, vertices): void
Parameters
- numContours: number
- numVertices: number
- vertices: OdGsDCPoint
Returns void

setViewportClipRegion1

setViewportClipRegion1(numContours, numVertices, vertices): void
Parameters
- numContours: number
- numVertices: number
- vertices: OdGePoint2d
Returns void

setVisualStyle

setVisualStyle(visualStyleId): void
Parameters
- visualStyleId: OdDbStub
Returns void

setVisualStyle1

setVisualStyle1(visualStyle): void
Parameters
- visualStyle: OdGiVisualStyle
Returns void

show

show(): void
Returns void

ssaoMode

ssaoMode(): boolean
Returns boolean

target

target(): OdGePoint3d
Returns OdGePoint3d

thawLayer

thawLayer(layerID): void
Parameters
- layerID: OdDbStub
Returns void

upVector

upVector(): OdGeVector3d
Returns OdGeVector3d

update

update(): void
Returns void

userGiContext

userGiContext(): OdGiContext
Returns OdGiContext

viewParameters

viewParameters(pView): void
Parameters
- pView: OdGsView
Returns void

viewingMatrix

viewingMatrix(): OdGeMatrix3d
Returns OdGeMatrix3d

viewportClipRegion

viewportClipRegion(counts, vertices): void
Parameters
- counts: OdIntArray
- vertices: OdGsDCPointArray
Returns void

viewportClipRegion1

viewportClipRegion1(counts, vertices): void
Parameters
- counts: OdIntArray
- vertices: OdGePoint2dArray
Returns void

visualStyle

visualStyle(): OdDbStub
Returns OdDbStub

visualStyle1

visualStyle1(visualStyle): boolean
Parameters
- visualStyle: OdGiVisualStyle
Returns boolean

worldToDeviceMatrix

worldToDeviceMatrix(): OdGeMatrix3d
Returns OdGeMatrix3d

x

x(pClass): OdRxObject
Parameters
- pClass: OdRxClass
Returns OdRxObject
Inherited from OdRxObject.x

zoom

zoom(zoomFactor): void
Parameters
- zoomFactor: number
Returns void

zoomExtents

zoomExtents(minPt, maxPt): void
Parameters
- minPt: OdGePoint3d
- maxPt: OdGePoint3d
Returns void

zoomWindow

zoomWindow(lowerLeft, upperRight): void
Parameters
- lowerLeft: OdGePoint2d
- upperRight: OdGePoint2d
Returns void

`Static`cast

cast(pObj): OdGsView
Parameters
- pObj: OdRxObject
Returns OdGsView
Overrides OdRxObject.cast

`Static`createObject

createObject(): OdGsView
Returns OdGsView

`Static`desc

desc(): OdRxClass
Returns OdRxClass
Overrides OdRxObject.desc

`Static`pseudoConstructor

pseudoConstructor(): OdRxObjectPtr
Returns OdRxObjectPtr

`Static`rxInit

rxInit(): void
Returns void
Overrides OdRxObject.rxInit

`Static`rxUninit

rxUninit(): void
Returns void
Overrides OdRxObject.rxUninit