View¶

Inheritance diagram¶

Classes¶

View¶

class ORSModel.ors.View(*args, **kwargs)¶

Bases: Node

Represents a host window where the renderer is displayed.

compile(self)¶

decrementTimeStep(self)¶: See also

ORSModel.ors.View.incrementTimeStep()

draw(self)¶: Forces an immediate draw of the view.

drawOnCurrentGLContext(self, bCapture: bool)¶

Parameters:: bCapture (bool) –

drawTextAtPosition(self, text: str, fontname: str, fontsize: int, positionX: float, positionY: float, color: ORSModel.ors.Color)¶

draws specific text at a 2D coordinate

Parameters:

text (str) – the text to be rendered (a wstring)
fontname (str) – the font name (a wstring)
fontsize (int) – the font size (an unsigned int)
positionX (float) – the X 2D coordinate (a double)
positionY (float) – the Y 2D coordinate (a double)
color (ORSModel.ors.Color) – thetext color (a Color)

exportSnapshotCustomSized(self, iWidth: int, iHeight: int, pOutputImage: ORSModel.ors.Image) → ORSModel.ors.Image¶

Note

This method saves a snapshot sized to specifications. The resulting image is always full resolution, no * matter what size is given.

Note

If an output image is support, the resulting snapshot is written to that output image. That same output image will be the return value.

Parameters:

iWidth (int) – the width of the image to be saved (a uint16_t)
iHeight (int) – the height of the image to be saved (a uint16_t)
pOutputImage (ORSModel.ors.Image) – (optional) an output image (an Image)

Returns:

output (ORSModel.ors.Image) – an image (an Image)

fitBoundedPlaneInView(self, IBoundedPlane: ORSModel.ors.Rectangle)¶

Parameters:: IBoundedPlane (ORSModel.ors.Rectangle) –

fitBoxInView(self, aBox: ORSModel.ors.Box)¶

Parameters:: aBox (ORSModel.ors.Box) –

gatherTimeStepMaxFromAll(self)¶: Queries all visible models to know how many timesteps there are.

get2DBackgroundColor(self) → ORSModel.ors.Color¶

Gets the view’s 3D first background color.

Returns:: output (ORSModel.ors.Color) – a color (an Color)

get3DBackgroundColor1(self) → ORSModel.ors.Color¶

Gets the view’s 3D first background color.

Returns:: output (ORSModel.ors.Color) – a color (an Color)

get3DBackgroundColor2(self) → ORSModel.ors.Color¶

Gets the view’s 3D first background color.

Returns:: output (ORSModel.ors.Color) – a color (a Color)

get3DBackgroundColorMode(self) → int¶

Note

The color mode has 3 different meanings: -2 says the color is uniform (i.e. the second color is ignored), -1 says the color is gradient radial (the two colors are used), any value between 0 and 359 says the color is gradient linear (the two colors are used), and that value indicates the angle of the gradient.

Returns:: output (int) – color mode (a short, see note below)

getAllChildrenOfClassesVisibleAndHighlightable(self, classes: List[str]) → ORSModel.ors.List¶

Returns a flattened list of all the child nodes, of the given class, that are renderable and highlightable.

Note

The list contains only Managed objects (they will need to be typecast to the appropriate class).

Parameters:: classes (List[str]) – the ProgId of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of all child nodes that can be rendered (an List)

getAllVisibleChildrenOfClass(self, pProgId: str) → ORSModel.ors.List¶

Returns a flattened list of all the child nodes, of the given class, that are visible.

Note

The list contains only Managed objects (they will need to be typecast to the appropriate class).

Parameters:: pProgId (str) – the ProgId of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of all child nodes that are visible (an List)

getAmbientLightColor(self) → ORSModel.ors.Color¶

Returns:: output (ORSModel.ors.Color) –

getAngleDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Returns:: output (ORSModel.ors.DimensionUnit) –

getAngularSpeed(self) → float¶

Returns:: output (float) –

getAutoFocus(self) → bool¶

Returns:: output (bool) –

getAutofocusFactor(self) → float¶

Returns:: output (float) –

classmethod getBestViewFromGenealogicalName(genealogicalName)¶

Return the most appropriate view for the given genealogicalName

Parameters:: genealogicalName (str) – a layout name hierachy
Returns:: output (ORSModel.ors.View) – return the best view for the given genealogicalName

getBorderColor(self) → ORSModel.ors.Color¶

Returns:: output (ORSModel.ors.Color) –

getBorderWidth(self) → float¶

Returns:: output (float) –

getBoundedPlaneOfFirstSliceOfBox(self, aBox: ORSModel.ors.Box) → ORSModel.ors.Rectangle¶

Parameters:: aBox (ORSModel.ors.Box) –
Returns:: output (ORSModel.ors.Rectangle) –

getBoundedPlaneOfLastSliceOfBox(self, aBox: ORSModel.ors.Box) → ORSModel.ors.Rectangle¶

Parameters:: aBox (ORSModel.ors.Box) –
Returns:: output (ORSModel.ors.Rectangle) –

getBoundedPlaneOfSliceOfBox(self, aBox: ORSModel.ors.Box, sliceIndex: int) → ORSModel.ors.Rectangle¶

Parameters:

aBox (ORSModel.ors.Box) –
sliceIndex (int) –

Returns:

output (ORSModel.ors.Rectangle) –

getBoxAbleToContainAllEnabledVisualReachableByRender(self, inbox: ORSModel.ors.Box) → ORSModel.ors.Box¶

Parameters:: inbox (ORSModel.ors.Box) –
Returns:: output (ORSModel.ors.Box) –

getBrightness(self) → int¶

Returns:: output (int) –

getCamera(self) → ORSModel.ors.Camera¶

Returns:: output (ORSModel.ors.Camera) – the GUID of the overlay if successful, should be a VisualOVerlay but this idl doesn’t allow it

getCameraSpaceLightPos(self, index: int) → ORSModel.ors.Vector3¶

Parameters:: index (int) –
Returns:: output (ORSModel.ors.Vector3) –

getCanBreakRendering(self) → bool¶

Returns:: output (bool) –

getCaptureBufferRatio(self) → float¶

Returns:: output (float) –

getCineMode(self) → int¶

Returns:: output (int) –

getClassNameStatic() → str¶

getClassNameStatic

Returns:: output (str) –

getContrast(self) → int¶

Returns:: output (int) –

getCurrentActiveLightIndex(self) → int¶

Returns:: output (int) –

getCurrentTimeStep(self) → int¶

Gets the view’s current time step.

Returns:: output (int) –

getDiffuseLightColor(self) → ORSModel.ors.Color¶

Returns:: output (ORSModel.ors.Color) –

getDimensionUnit(self, dimensionType: int) → ORSModel.ors.DimensionUnit¶

Gets the view’s dimension unit.

Note

See the ORS_def.h file for enum CxvUniverse_Dimension_type values.

Parameters:: dimensionType (int) – the unit type (a CxvUniverse_Dimension_type)
Returns:: output (ORSModel.ors.DimensionUnit) – the current dimension unit (DimensionUnit)

getDisplayedAxis(self, aBox: ORSModel.ors.Box) → int¶

Gets the axis direction of the view.

Note

The axis value is 0 for Sagittal, 1 for Coronal or 2 for Axial.

Parameters:: aBox (ORSModel.ors.Box) –
Returns:: output (int) – the axis (a uint16_t)

getDrawFocusRect(self) → bool¶

Returns:: output (bool) –

getEnableFocus(self) → bool¶

Returns:: output (bool) –

getExportTransparentBackground(self) → bool¶

Returns:: output (bool) –

getFadeFactor(self) → float¶

Returns:: output (float) –

getFitToViewBorder(self) → int¶

Gets the number of pixels allocated to the border around the view.

Returns:: output (int) – the number of pixels (a int32_t*)

getFocalDistance(self) → float¶

Returns:: output (float) –

getFocalRange(self) → float¶

Returns:: output (float) –

getFocusSigma(self) → float¶

Returns:: output (float) –

getGammaCorrection(self) → float¶

Returns:: output (float) –

getGlobalVolumeOpacity(self) → float¶

Returns:: output (float) –

getHWND(self) → int¶

Gets the view handle.

Returns:: output (int) – the handle of the window

getHue(self) → int¶

Returns:: output (int) –

getImageNumberingAscending(self) → bool¶

Returns:: output (bool) –

getIntersliceDistance(self, box: ORSModel.ors.Box) → float¶

Parameters:: box (ORSModel.ors.Box) –
Returns:: output (float) –

getIs3DAllowed(self) → bool¶

Gets view 3D allowed attribute.

Note

This is used by the 3D renderer

Returns:: output (bool) – true if can be in 3D

getIsBackLight(self, index: int) → bool¶

Parameters:: index (int) –
Returns:: output (bool) –

getIsBorderEnabled(self) → bool¶

Returns:: output (bool) –

getIsChildReachableByRenderer(self, INode: ORSModel.ors.Node) → bool¶

Verifies if a child node is renderable.

Parameters:: INode (ORSModel.ors.Node) – a node in the child hierarchy of the view (a Node)
Returns:: output (bool) – true if the node is renderable, false otherwise

getIsEnabled(self) → bool¶

Queries the view to know if it is enabled.

Note

Disabled views are “inert”, they react to very few events and display nothing.

Returns:: output (bool) – true if the view is enabled, false otherwise

getIsIn2DNonPlanarViewMode(self) → bool¶

Returns:: output (bool) –

getIsIn2DPlanarViewMode(self) → bool¶

Returns:: output (bool) –

getIsIn2DSlabAverageMode(self) → bool¶

Returns:: output (bool) –

getIsIn2DSlabMode(self) → bool¶

Returns:: output (bool) –

getIsIn2DSlabThinMIPMode(self) → bool¶

Returns:: output (bool) –

getIsIn2DSlabThinmipMode(self) → bool¶

Returns:: output (bool) –

getIsIn2DSliceMode(self) → bool¶

Returns:: output (bool) –

getIsIn3DViewMode(self) → bool¶

Returns:: output (bool) –

getIsInAcquisitionPlaneOf(self, aStructuredGrid: ORSModel.ors.StructuredGrid) → bool¶

Parameters:: aStructuredGrid (ORSModel.ors.StructuredGrid) –
Returns:: output (bool) –

getIsInAny2DViewMode(self) → bool¶

Returns:: output (bool) –

getIsInNoViewMode(self) → bool¶

Returns:: output (bool) –

getIsLightingEnabled(self) → bool¶

Returns:: output (bool) –

getIsOrientationAndPositionLocked(self) → bool¶

Gets the view’s position and orientation lock status.

Note

When a view position is locked, one cannot set its oblique info.

Returns:: output (bool) – true if the view position and orientation is locked, false otherwise

getIsOrientationLocked(self) → bool¶

Gets the view’s orientation lock status.

Note

When a view orientation is locked, one cannot set its oblique info.

Returns:: output (bool) – true if the view orientation is locked, false otherwise

getIsOrthoProjection(self) → bool¶

Returns:: output (bool) –

getIsPositionLocked(self) → bool¶

Gets the view’s position lock status.

Note

When a view position is locked, one cannot set its oblique info.

Returns:: output (bool) – true if the view position is locked, false otherwise

getIsRenderingCapture(self) → bool¶

Returns:: output (bool) –

getIsRenderingTiled(self) → bool¶

Returns:: output (bool) –

getIsShadowEnabled(self) → bool¶

Returns:: output (bool) –

getIsSpinning(self) → bool¶

Returns:: output (bool) –

getIsTrackingLight(self) → bool¶

Queries if the view is in tracking light mode or not.

Returns:: output (bool) – true if the view is in tracking light mode, false otherwise

getIsViewRepresentationEnabled(self) → bool¶

Returns:: output (bool) –

getIsVirtualFloorEnabled(self) → bool¶

Returns:: output (bool) –

getLODEnabled(self) → bool¶

Returns:: output (bool) –

getLODFactor(self) → float¶

Returns:: output (float) –

getLODMode(self) → int¶

Note

LOD stands for Level Of Detail. It defines how much detail is displayed when moving the visual artifacts in the view. The lower the level, the faster the visual will move.

Note

See the ORS_def.h file, it contains defines (in the form CXV_DISPLAY_LOD_XXX) for valid values.

See also

ORSModel.ors.View.setLODMode()

Returns:: output (int) – an LOD mode (a int32_t*)

getLODSamplingFactor(self) → float¶

Returns:: output (float) –

getLayout()¶

Gets the Layout of the view

Returns:: aName (str) – the genealogical name of the view

getLayoutGenealogicalFirstName()¶

Gets the genealogical first name of the view, like xy, xz, yz

Returns:: aName (str) – the genealogical first name of the view

getLayoutGenealogicalName()¶

Gets the genealogical name of the view

Returns:: aName (str) – the genealogical name of the view

getLengthAsPixelCount(self, aLength: float) → float¶

Gets the number of pixels on the screen that represent a world length.

Parameters:: aLength (float) – the world length (a double)
Returns:: output (float) – the number of pixels that match the length (a double)

getLengthDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Returns:: output (ORSModel.ors.DimensionUnit) –

getLengthReciprocalDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Returns:: output (ORSModel.ors.DimensionUnit) –

getLightFollowCamera(self) → bool¶

Returns:: output (bool) –

getLightIntensity(self, index: int) → float¶

Parameters:: index (int) –
Returns:: output (float) –

getLightMaxDistance(self) → float¶

Returns:: output (float) –

getLightingInMotion(self) → bool¶

Returns:: output (bool) –

getLocalPositionArrayTransformedToXY(self, pVisual: ORSModel.ors.Visual, pLocalPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pTimeStep: int, pOutputXYPositions: ORSModel.ors.SequenceableCollection) → ORSModel.ors.SequenceableCollection¶

Parameters:

pVisual (ORSModel.ors.Visual) –
pLocalPositions (ORSModel.ors.SequenceableCollection) –
nPtsCount (int) –
pTimeStep (int) –
pOutputXYPositions (ORSModel.ors.SequenceableCollection) –

Returns:

output (ORSModel.ors.SequenceableCollection) –

getLocalPositionFromVisualLocalPosition(self, pVisual: ORSModel.ors.Visual, anotherVisual: ORSModel.ors.Visual, pAlocalPositionInAnotherVisual: ORSModel.ors.Vector3, pTimeStep: int) → ORSModel.ors.Vector3¶

Parameters:

pVisual (ORSModel.ors.Visual) –
anotherVisual (ORSModel.ors.Visual) –
pAlocalPositionInAnotherVisual (ORSModel.ors.Vector3) –
pTimeStep (int) –

Returns:

output (ORSModel.ors.Vector3) –

getLocalPositionFromWorldPosition(self, pVisual: ORSModel.ors.Visual, pWorldPosition: ORSModel.ors.Vector3, pTimeStep: int) → ORSModel.ors.Vector3¶

Parameters:

pVisual (ORSModel.ors.Visual) –
pWorldPosition (ORSModel.ors.Vector3) –
pTimeStep (int) –

Returns:

output (ORSModel.ors.Vector3) –

getLocalPositionTransformedToXY(self, IVisual: ORSModel.ors.Visual, pCoord: ORSModel.ors.Vector3, oY: float) → bool¶

Transforms a local coordinate in 2D coordinates.

Note

The values are returned in the last two parameters supplied.

Parameters:

IVisual (ORSModel.ors.Visual) – the visual (an Visual)
pCoord (ORSModel.ors.Vector3) – a coordinate (an Vector3)
oY (float) –

Returns:

output (bool) – true if the local Z coordinate is currently visible, false otherwise
pTimeStep (int) – the X 2D coordinate (a double*)
oX (float) – the Y 2D coordinate (a double*)

getLuminosity(self) → int¶

Returns:: output (int) –

getMaxTimeStep(self) → int¶

Returns:: output (int) –

getMillisecondsElapsedSinceLastDraw(self) → int¶

Returns the time elapsed since the last draw, in milliseconds.

Returns:: output (int) – the elapsed time, in milliseconds (a uint32_t)

getNeedRefresh(self) → bool¶

Returns:: output (bool) –

getNextSliceDirectionOfBox(self, aBox: ORSModel.ors.Box) → ORSModel.ors.Vector3¶

Parameters:: aBox (ORSModel.ors.Box) –
Returns:: output (ORSModel.ors.Vector3) –

getNumberOfLights(self) → int¶

Returns:: output (int) –

getOcclusionLODFactor(self) → int¶

Returns:: output (int) –

getOrthoZoomFactor(self) → float¶

Returns:: output (float) –

getPickData(self, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → ORSModel.ors.Intersection¶

Note

Returns an intersection describing what is currently under the mouse cursor in the view.

See also

ORSModel.ors.View.getPickVisualData(), getPickPlaneData()

Parameters:

pixelXPositionInDisplay (int) –
pixelYPositionInDisplay (int) –

Returns:

output (ORSModel.ors.Intersection) – an intersection (an Intersection)

getPickVisualData(self, aIVisual: ORSModel.ors.Visual, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → ORSModel.ors.Intersection¶

Note

Returns an intersection describing what is currently being picked in the visual supplied. If the given visual is not being picked, getHit() on the intersection will return FALSE.

See also

pick(), getPickPlaneData()

Parameters:

aIVisual (ORSModel.ors.Visual) – a visual (an Visual)
pixelXPositionInDisplay (int) –
pixelYPositionInDisplay (int) –

Returns:

output (ORSModel.ors.Intersection) – an intersection (an Intersection)

getPickVisualDataConstrained(self, aIVisual: ORSModel.ors.Visual, currentPosition: ORSModel.ors.Vector3, constraintOrigin: ORSModel.ors.Vector3, constraintDirection: ORSModel.ors.Vector3, testDirection: bool) → ORSModel.ors.Intersection¶

Note

Returns an intersection describing what is currently being picked in the visual supplied, constrained to the specified line. If the given visual is not being picked, getHit() on the intersection will return FALSE.

See also

pick(), ORSModel.ors.View.getPickVisualData(), getPickPlaneData()

Parameters:

aIVisual (ORSModel.ors.Visual) – a visual (an Visual)
currentPosition (ORSModel.ors.Vector3) – the constraint origin (a Vector3)
constraintOrigin (ORSModel.ors.Vector3) – the constraint direction (a Vector3)
constraintDirection (ORSModel.ors.Vector3) – test for face normal (a bool)
testDirection (bool) –

Returns:

output (ORSModel.ors.Intersection) – an intersection (an Intersection)

getProjectionMatrix(self) → ORSModel.ors.Matrix4x4¶

Returns:: output (ORSModel.ors.Matrix4x4) –

getProjectionMode2D(self) → int¶

See also

ORSModel.ors.View.setProjectionMode2D(), setProjectionMode(), getProjectionMode()

Returns:: output (int) –

getRectangle()¶

Get the rectangle in the space defined by the View

Returns:: rectangle (ORSModel.ors.Rectangle) – a Rectangle

getReflectionPolishFactor(self) → float¶

Returns:: output (float) –

getReflectiveSurfaceEnabled(self) → bool¶

Returns:: output (bool) –

getRenderCount(self) → int¶

Returns the number of times theView was rendered (draw)

Returns:: output (int) – the rendereing count (unint32)

getRenderMode() → int¶

Gets the view render mode.

Deprecated since version (unknown): use VisualChannel.getRenderModeForDisplay() instead

Returns:: output (int) – a render mode (a uint16_t, see ors_def.h)

getRestTime(self) → int¶

Note

The rendering idle time is the period of time between cycles. Increasing this value makes the renderer less responsive.

Note

Default value is 22 ms.

Returns:: output (int) – a number of milliseconds (a LONG)

getRotationAxis(self) → ORSModel.ors.Vector3¶

Returns:: output (ORSModel.ors.Vector3) –

getSaturation(self) → int¶

Returns:: output (int) –

getSceneLayoutGenealogicalName()¶

Gets the genealogical name of the scene layout of the view

Returns:: aName (str) – the genealogical name of the scene layout of the view

getScreenLengthTransformedToWorldLength(self, inLength: float) → float¶

Parameters:: inLength (float) –
Returns:: output (float) –

getShadowMapSize(self) → int¶

Returns:: output (int) –

getShadowOpacity(self) → float¶

Returns:: output (float) –

getShadowPrecision(self) → float¶

Returns:: output (float) –

getShadowStrength(self) → float¶

Returns:: output (float) –

getShowOrientationIndicators(self) → bool¶

Gets the visibility of the orientation indicators.

Returns:: output (bool) – true if the orientation indicators are visible, false otherwise

getShowViewFPS(self) → bool¶

Returns:: output (bool) –

getSlabThickness(self) → float¶

Gets the view’s slab thickness.

Note

Note that this value represents the half slab thickness, in microns.

Returns:: output (float) – the slab thickness, in microns (a double)

getSliceCountOfBox(self, aBox: ORSModel.ors.Box) → int¶

Gets the number of slices of a given box.

Parameters:: aBox (ORSModel.ors.Box) – the visual box (a Box)
Returns:: output (int) – the number of slices in the box, in the current camera direction (a uint32_t)

getSliceIndexOfBox(self, aBox: ORSModel.ors.Box) → float¶

Gets the current slice position of a given box.

Parameters:: aBox (ORSModel.ors.Box) – the visual box (an Box)
Returns:: output (float) – the current slice position in the box

getSpecularLightColor(self) → ORSModel.ors.Color¶

Returns:: output (ORSModel.ors.Color) –

getSpotlightFactor(self) → float¶

Returns:: output (float) –

getSurfaceDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Gets the view’s surface dimension unit.

Returns:: output (ORSModel.ors.DimensionUnit) –

getSurfaceReciprocalDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Returns:: output (ORSModel.ors.DimensionUnit) –

getTopFrame()¶: Gets the top frame of the view

getTransformationShape3D(self) → ORSModel.ors.Shape3D¶

Returns:: output (ORSModel.ors.Shape3D) –

getUseCustomCursor(self) → bool¶

Returns:: output (bool) –

getUseMedianIn3D(self) → bool¶

Returns:: output (bool) –

getUseSuperSampling(self) → bool¶

Returns:: output (bool) –

getValueInCurrentUnitConvertedToMeter(self, pValue: float) → float¶

Note

This method is the reverse of getValueInMeterConvertedToCurrentUnit().

Note

The value to be converted is assumed to be expressed in the view’s current dimension unit. For example, if the view’s current unit is cm, getValueInCurrentUnitConvertedToMeter(1.0) will return 0.01 (1 meter -> 100 cm).

Parameters:: pValue (float) – the value to be converted (a double)
Returns:: output (float) – the value converted to meters (a double)

getValueInMeterConvertedToCurrentUnit(self, pValue: float) → float¶

Note

The value to be converted is always assumed to be expressed in meters, the reference internal unit. For example, if the view’s current unit is cm, getValueInMeterConvertedToCurrentUnit(1.0) will return 100 (1 meter -> 100 cm).

Note

This method is the reverse of getValueInCurrentUnitConvertedToMeter().

Parameters:: pValue (float) – the value (in meters) to be converted (a double)
Returns:: output (float) – the value converted (a double)

getViewAlignedBoxThatContainsAllEnabledVisualsReachableByRenderer(self) → ORSModel.ors.Box¶

Returns:: output (ORSModel.ors.Box) –

getViewBoundedPlaneInWorldCoordinates(self) → ORSModel.ors.Rectangle¶

Returns a plane bounded to the view, in world coordinates.

Returns:: output (ORSModel.ors.Rectangle) – a plane (an Rectangle)

getViewCenter(self) → ORSModel.ors.Vector3¶

Returns:: output (ORSModel.ors.Vector3) –

getViewMatrix(self) → ORSModel.ors.Matrix4x4¶

Returns:: output (ORSModel.ors.Matrix4x4) –

getViewMode(self) → int¶

Gets the view’s volume mode.

Note

See the ORS_def.h file for valid values.

See also

ORSModel.ors.View.setViewMode()

Returns:: output (int) – a CxvView_Mode (a int32_t*)

getViewNormal(self) → ORSModel.ors.Vector3¶

Returns:: output (ORSModel.ors.Vector3) –

getViewOrientedBoxThatContainsBox(self, aBox: ORSModel.ors.Box) → ORSModel.ors.Box¶

Parameters:: aBox (ORSModel.ors.Box) –
Returns:: output (ORSModel.ors.Box) –

getViewOrientedPlane(self) → ORSModel.ors.OrientedPlane¶

Returns:: output (ORSModel.ors.OrientedPlane) –

getViewPlane(self) → ORSModel.ors.Plane¶

Returns:: output (ORSModel.ors.Plane) –

getViewRepresentationColor(self) → ORSModel.ors.Color¶

Gets the view’s representation color.

Note

This call is used to query the color that represents the view.

Returns:: output (ORSModel.ors.Color) – a color (a Color)

getVirtualFloorColor(self) → ORSModel.ors.Color¶

Returns:: output (ORSModel.ors.Color) –

getVirtualFloorPlane(self) → ORSModel.ors.Plane¶

Returns:: output (ORSModel.ors.Plane) –

getVirtualFloorSize(self) → float¶

Returns:: output (float) –

getVolumeDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Returns:: output (ORSModel.ors.DimensionUnit) –

getVolumeReciprocalDimensionUnit(self) → ORSModel.ors.DimensionUnit¶

Returns:: output (ORSModel.ors.DimensionUnit) –

getWorldLengthTransformedToScreenLength(self, inLength: float) → float¶

Parameters:: inLength (float) –
Returns:: output (float) –

getWorldPositionArrayTransformedToXY(self, pWorldPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pOutputXYPositions: ORSModel.ors.SequenceableCollection) → ORSModel.ors.SequenceableCollection¶

Parameters:

pWorldPositions (ORSModel.ors.SequenceableCollection) –
nPtsCount (int) –
pOutputXYPositions (ORSModel.ors.SequenceableCollection) –

Returns:

output (ORSModel.ors.SequenceableCollection) –

getWorldPositionFromLocalPosition(self, pVisual: ORSModel.ors.Visual, pLocalPosition: ORSModel.ors.Vector3, pTimeStep: int) → ORSModel.ors.Vector3¶

Parameters:

pVisual (ORSModel.ors.Visual) –
pLocalPosition (ORSModel.ors.Vector3) –
pTimeStep (int) –

Returns:

output (ORSModel.ors.Vector3) –

getWorldPositionTransformedToScreenCoord(self, pPosition: ORSModel.ors.Vector3) → ORSModel.ors.Vector3¶

Parameters:: pPosition (ORSModel.ors.Vector3) –
Returns:: output (ORSModel.ors.Vector3) –

getWorldPositionTransformedToXY(self, pPosition: ORSModel.ors.Vector3) → bool¶

Transforms a world coordinate in 2D coordinates.

Note

The values are returned in the last two parameters supplied.

Parameters:

pPosition (ORSModel.ors.Vector3) – a position (an Vector3)

Returns:

output (bool) – true if the world Z coordinate is currently visible, false otherwise
oX (float) – the X 2D coordinate (a double*)
oY (float) – the Y 2D coordinate (a double*)

getXSize(self) → int¶

Gets the view X size.

Returns:: output (int) – the X size, in pixels (a uint16_t)

getXYArrayTransformedToLocalPosition(self, pVisual: ORSModel.ors.Visual, pXYPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pTimeStep: int, pOutputLocalPositions: ORSModel.ors.SequenceableCollection) → ORSModel.ors.SequenceableCollection¶

Parameters:

pVisual (ORSModel.ors.Visual) –
pXYPositions (ORSModel.ors.SequenceableCollection) –
nPtsCount (int) –
pTimeStep (int) –
pOutputLocalPositions (ORSModel.ors.SequenceableCollection) –

Returns:

output (ORSModel.ors.SequenceableCollection) –

getXYArrayTransformedToWorldPosition(self, pXYPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pOutputWorldPositions: ORSModel.ors.SequenceableCollection) → ORSModel.ors.SequenceableCollection¶

Parameters:

pXYPositions (ORSModel.ors.SequenceableCollection) –
nPtsCount (int) –
pOutputWorldPositions (ORSModel.ors.SequenceableCollection) –

Returns:

output (ORSModel.ors.SequenceableCollection) –

getXYTransformedToWorldPosition(self, x: float, y: float) → ORSModel.ors.Vector3¶

Transforms a 2D coordinates to world coordinate.

Note

The world coordinate is projected on the current view bounded plane.

Parameters:

x (float) – the X 2D coordinate (a double)
y (float) – the Y 2D coordinate (a double)

Returns:

output (ORSModel.ors.Vector3) – a position in world coordinate(an Vector3)

getYSize(self) → int¶

Gets the view Y size.

Returns:: output (int) – the Y size, in pixels (a uint16_t)

getZoomFactor(self) → float¶

Gets the current zoom factor.

Returns:: output (float) – zoom factor (a double)

getdepthMapFarValue(self) → float¶

Returns:: output (float) –

getdepthMapNearValue(self) → float¶

Returns:: output (float) –

imhide(node)¶

With a view, hide the node (such as a Channel, ROI, Mesh) in this view

Parameters:: node (ORSModel.ors.Node) –

imshow(node, lut=None)¶

With a view, show the node (such as a Channel, ROI, Mesh) in this view with an optional Lookup Table

Parameters:

node (ORSModel.ors.Node) –
lut (ORSModel.ors.LookupTable) –

incrementTimeStep(self)¶: See also

ORSModel.ors.View.decrementTimeStep()

none() → View¶

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (View) –

refresh(self)¶: Refreshes the view.

Note

The view is not immediately refreshed, it will be so when the next timer fires up.

refreshAndWait()¶: Forces a refresh of the view and wait for the refresh to be finished before return

resetNeedRefresh(self)¶

saveScreenshot(filename, scale=1.0)¶

Save a screenshot

Parameters:

filename (file saving) – path to save
scale (float) – scaling factor

set2DBackgroundColor(self, IColor: ORSModel.ors.Color)¶

Sets the view’s 2D background color.

Note

The color should be expressed as RGB (the alpha is not used here).

Parameters:: IColor (ORSModel.ors.Color) – a color (an Color)

set3DBackgroundColor(self, iMode: int, IColor1: ORSModel.ors.Color, IColor2: ORSModel.ors.Color)¶

Sets the view’s 3D background color.

Note

The colors should be expressed as RGB (the alpha is not used here).

Parameters:

iMode (int) – a mode (a short)
IColor1 (ORSModel.ors.Color) – a color (an Color)
IColor2 (ORSModel.ors.Color) – a color (an Color)

setAmbientLightColor(self, IColor: ORSModel.ors.Color)¶

Parameters:: IColor (ORSModel.ors.Color) –

setAngularSpeed(self, value: float)¶

Parameters:: value (float) –

setAutoFocus(self, aValue: bool)¶

Parameters:: aValue (bool) –

setAutofocusFactor(self, value: float)¶

Parameters:: value (float) –

setBorderColor(self, IColor: ORSModel.ors.Color)¶

Parameters:: IColor (ORSModel.ors.Color) –

setBorderWidth(self, aValue: float)¶

Parameters:: aValue (float) –

setBrightness(self, value: int)¶

Parameters:: value (int) –

setCamera(self, aCamera: ORSModel.ors.Camera)¶

Parameters:: aCamera (ORSModel.ors.Camera) –

setCameraSpaceLightPos(self, index: int, pPosition: ORSModel.ors.Vector3)¶

Parameters:

index (int) –
pPosition (ORSModel.ors.Vector3) –

setCanBreakRendering(self, value: bool)¶

Parameters:: value (bool) –

setCaptionTextFontName(self, sFontName: str)¶

Parameters:: sFontName (str) –

setCaptureBufferRatio(self, pValue: float)¶

Parameters:: pValue (float) –

setCineMode(self, mode: int)¶

Parameters:: mode (int) –

setContrast(self, value: int)¶

Parameters:: value (int) –

setCurrentActiveLightIndex(self, value: int)¶

Parameters:: value (int) –

setCurrentTimeStep(self, value: int)¶

Parameters:: value (int) –

setCustomCursorInfos(self, width: int, height: int, iMode: int, caption: str, color: ORSModel.ors.Color)¶

Parameters:

width (int) –
height (int) –
iMode (int) –
caption (str) –
color (ORSModel.ors.Color) –

setCustomCursorPosition(self, posX: int, posY: int)¶

Parameters:

posX (int) –
posY (int) –

setDiffuseLightColor(self, IColor: ORSModel.ors.Color)¶

Parameters:: IColor (ORSModel.ors.Color) –

setDimensionUnit(self, dimensionType: int, aDimensionUnit: ORSModel.ors.DimensionUnit)¶

Parameters:

dimensionType (int) –
aDimensionUnit (ORSModel.ors.DimensionUnit) –

setDimensionUnitID(self, dimensionType: int, pUnit: int)¶

Deprecated since version (unknown): use setDimensionUnit instead

Note

See the ORS_def.h file for enum CxvUniverse_Dimension and CxvUniverse_Dimension_type values.

Parameters:

dimensionType (int) – the unit type (a CxvUniverse_Dimension_type)
pUnit (int) – a CxvUniverse_Dimension unit (an int32_t)

setDrawFocusRect(self, value: bool)¶

Parameters:: value (bool) –

setEnableFocus(self, aValue: bool)¶

Parameters:: aValue (bool) –

setExportTransparentBackground(self, aValue: bool)¶

Parameters:: aValue (bool) –

setFadeFactor(self, value: float)¶

Parameters:: value (float) –

setFitToViewBorder(self, value: int)¶

Sets the number of pixels allocated to the border around the view.

Parameters:: value (int) – the number of pixels (a int32_t*)

setFocalDistance(self, aValue: float)¶

Parameters:: aValue (float) –

setFocalRange(self, value: float)¶

Parameters:: value (float) –

setFocusSigma(self, aValue: float)¶

Parameters:: aValue (float) –

setGammaCorrection(self, value: float)¶

Parameters:: value (float) –

setGlobalVolumeOpacity(self, aValue: float)¶

Parameters:: aValue (float) –

setHue(self, value: int)¶

Parameters:: value (int) –

setImageNumberingAscending(self, value: bool)¶

Parameters:: value (bool) –

setInImagePlaneOfBox(box)¶

Sets the view in the image plane of the given box

Parameters:: box (ORSModel.ors.Box) – box to align the view with

setIs3DAllowed(self, isAllowed: bool)¶

Set if the view is allowed to be in 3D viewmode.

Note

This is used by the 3D renderer

Parameters:: isAllowed (bool) –

setIsBackLight(self, index: int, value: bool)¶

Parameters:

index (int) –
value (bool) –

setIsBorderEnabled(self, aValue: bool)¶

Enables or disables the view border.

Parameters:: aValue (bool) – true to enable the border, false to disable it.

setIsEnabled(self, pEnabled: bool)¶

Enables or disables the view.

Note

Disabled views are “inert”, they react to very few events and display nothing.

Parameters:: pEnabled (bool) – true to enable the view, false to disable it

setIsLightingEnabled(self, value: bool)¶

Parameters:: value (bool) –

setIsOrientationAndPositionLocked(self, value: bool)¶

Sets the view’s position lock status.

Note

When a view position is locked, one cannot set its oblique info.

Parameters:: value (bool) – true to lock the view position, false otherwise

setIsOrientationLocked(self, value: bool)¶

Sets the view’s orientation lock status.

Note

When a view orientation is locked, one cannot set its oblique info.

Parameters:: value (bool) – true to lock the view orientation, false otherwise

setIsOrthoProjection(self, value: bool)¶

Parameters:: value (bool) –

setIsPositionLocked(self, value: bool)¶

Sets the view’s position lock status.

Note

When a view position is locked, one cannot set its oblique info.

Parameters:: value (bool) – true to lock the view position, false otherwise

setIsRenderingCapture(self, pVal: bool)¶

Parameters:: pVal (bool) –

setIsShadowEnabled(self, aValue: bool)¶

Parameters:: aValue (bool) –

setIsSpinning(self, value: bool)¶

Parameters:: value (bool) –

setIsTrackingLight(self, value: bool)¶

Sets the view to be in tracking light mode or not.

Parameters:: value (bool) – true to be in tracking light mode, false otherwise

setIsViewRepresentationEnabled(self, aValue: bool)¶

Enables or disables the view representation.

Parameters:: aValue (bool) – true to enable the view representation, false to disable it.

setIsVirtualFloorEnabled(self, value: bool)¶

Parameters:: value (bool) –

setLODEnabled(self, aValue: bool)¶

Parameters:: aValue (bool) –

setLODFactor(self, aValue: float)¶

Parameters:: aValue (float) –

setLODMode(self, dwMode: int)¶

Note

LOD stands for Level Of Detail. It defines how much detail is displayed when moving the visual artifacts in the view. The lower the level, the faster the visual will move.

Note

See the ORS_def.h file, it contains defines (in the form CXV_DISPLAY_LOD_XXX) for valid values.

See also

ORSModel.ors.View.getLODMode()

Parameters:: dwMode (int) – an LOD mode (a int32_t*)

setLODSamplingFactor(self, aValue: float)¶

Parameters:: aValue (float) –

setLightFollowCamera(self, aValue: bool)¶

Parameters:: aValue (bool) –

setLightIntensity(self, index: int, value: float)¶

Parameters:

index (int) –
value (float) –

setLightMaxDistance(self, aValue: float)¶

Parameters:: aValue (float) –

setLightingInMotion(self, value: bool)¶

Parameters:: value (bool) –

setLuminosity(self, value: int)¶

Parameters:: value (int) –

setNumberOfLights(self, value: int)¶

Parameters:: value (int) –

setOcclusionLODFactor(self, aValue: int)¶

Parameters:: aValue (int) –

setOrientationIndicators(self, left: str, right: str, up: str, down: str, top: str, bottom: str)¶

Sets the orientation indicators.

Parameters:

left (str) – 6 string, one for each orientation indicator
right (str) –
up (str) –
down (str) –
top (str) –
bottom (str) –

setOrientedPlaneWithBox(self, anOrientedPlane: ORSModel.ors.OrientedPlane, aBox: ORSModel.ors.Box)¶

Parameters:

anOrientedPlane (ORSModel.ors.OrientedPlane) –
aBox (ORSModel.ors.Box) –

setOrthoZoomFactor(self, value: float)¶

Parameters:: value (float) –

setProjectionMode2D(self, iMode: int)¶

See also

ORSModel.ors.View.getProjectionMode2D(), setProjectionMode(), getProjectionMode()

Parameters:: iMode (int) –

setReflectionPolishFactor(self, aValue: float)¶

Parameters:: aValue (float) –

setReflectiveSurfaceEnabled(self, aValue: bool)¶

Parameters:: aValue (bool) –

setRenderMode(self, mode: int)¶

Sets the view render mode.

Deprecated since version (unknown): use VisualChannel.setRenderModeForDisplay() instead

Parameters:: mode (int) – an OrsRenderMode (a uint16_t, see ors_def.h)

setRestTime(self, value: int)¶

Parameters:: value (int) –

setRotationAxis(self, value: ORSModel.ors.Vector3)¶

Parameters:: value (ORSModel.ors.Vector3) –

setSaturation(self, value: int)¶

Parameters:: value (int) –

setShadowMapSize(self, value: int)¶

Parameters:: value (int) –

setShadowOpacity(self, aValue: float)¶

Parameters:: aValue (float) –

setShadowPrecision(self, aValue: float)¶

Parameters:: aValue (float) –

setShadowStrength(self, aValue: float)¶

Parameters:: aValue (float) –

setShowOrientationIndicators(self, pFlag: bool)¶

Sets the visibility of the orientation indicators.

Parameters:: pFlag (bool) – true to show the orientation indicators, false to hide them

setShowViewFPS(self, bShow: bool)¶

Parameters:: bShow (bool) –

setSize(self, xSize: int, ySize: int)¶

Sets the view size.

Parameters:

xSize (int) – the X size, in pixels (a uint16_t)
ySize (int) – the Y size, in pixels (a uint16_t)

setSlabThickness(self, value: float)¶

Sets the view’s slab thickness.

Note

Note that this value should represent the half slab thickness, in microns.

Parameters:: value (float) – the slab thickness, in microns (a double)

setSliceIndexOfBox(self, aBox: ORSModel.ors.Box, sliceIndex: float)¶

Sets the current slice position for a given box.

Parameters:

aBox (ORSModel.ors.Box) – the visual box (an Box)
sliceIndex (float) – the slice position in the box to set

setSpecularLightColor(self, IColor: ORSModel.ors.Color)¶

Parameters:: IColor (ORSModel.ors.Color) –

setSpotlightFactor(self, aValue: float)¶

Parameters:: aValue (float) –

setTransformationShape3D(self, aShape: ORSModel.ors.Shape3D)¶

Parameters:: aShape (ORSModel.ors.Shape3D) –

setUseCustomCursor(self, bUse: bool)¶

Parameters:: bUse (bool) –

setUseMedianIn3D(self, aValue: bool)¶

Parameters:: aValue (bool) –

setUseOrthographicProjectionIn3D(ortho)¶

Use or not orthographic projection in 3D

Parameters:: ortho (bool) – use orthographic projection

setUseSuperSampling(self, aValue: bool)¶

Parameters:: aValue (bool) –

setViewInOneForOne(self, aBox: ORSModel.ors.Box)¶

Parameters:: aBox (ORSModel.ors.Box) –

setViewMode(self, viewMode: int)¶

Sets the view’s volume mode.

Note

See the ORS_def.h file for valid values.

See also

ORSModel.ors.View.getViewMode()

Parameters:: viewMode (int) – a CxvView_Mode (a int32_t*)

setViewOrientedPlane(self, anOrientedPlane: ORSModel.ors.OrientedPlane, aSlabThickness: float)¶

Parameters:

anOrientedPlane (ORSModel.ors.OrientedPlane) –
aSlabThickness (float) –

setViewPlanePosition(self, worldPosition: ORSModel.ors.Vector3, centerView: bool)¶

Parameters:

worldPosition (ORSModel.ors.Vector3) –
centerView (bool) –

setViewRepresentationColor(self, IColor: ORSModel.ors.Color)¶

Sets the view’s representation color.

Note

This call is used to specify the color that represents the view

Parameters:: IColor (ORSModel.ors.Color) – a color (an Color)

setVirtualFloorColor(self, value: ORSModel.ors.Color)¶

Parameters:: value (ORSModel.ors.Color) –

setVirtualFloorPlane(self, plane: ORSModel.ors.Plane)¶

Parameters:: plane (ORSModel.ors.Plane) –

setVirtualFloorSize(self, value: float)¶

Parameters:: value (float) –

setXSize(self, xSize: int)¶

Sets the view X size.

Parameters:: xSize (int) – the X size, in pixels (a uint16_t)

setYSize(self, ySize: int)¶

Sets the view Y size.

Parameters:: ySize (int) – the Y size, in pixels (a uint16_t)

setZoomFactor(self, value: float)¶

Parameters:: value (float) –

setdepthMapFarValue(self, aValue: float)¶

Parameters:: aValue (float) –

setdepthMapNearValue(self, aValue: float)¶

Parameters:: aValue (float) –

Node¶

class ORSModel.ors.Node(*args, **kwargs)

Bases: Managed

An abstract class for any object that can be a node in the visualization flow.

attachChild(self, anINode: ORSModel.ors.Node) → bool

Attaches a child node.

Note

Certain parent-child relationships are forbidden, hence the need to verify the result.

Note

Calling this method several times will still result in the child node only appearing once in its parent.

Parameters:: anINode (ORSModel.ors.Node) – the node to attach (a Node)
Returns:: output (bool) – true if child was attached, false otherwise

attachChildAtIndex(self, anINode: ORSModel.ors.Node, index: int) → bool

Attaches a child node at a given index.

Note

Certain parent-child relationships are forbidden, hence the need to verify the result.

Note

Calling this method several times will still result in the child node only appearing once in its parent.

Parameters:

anINode (ORSModel.ors.Node) – the node to attach (a Node)
index (int) – the index (a uint32_t)

Returns:

output (bool) – true if child was attached, false otherwise

copyGraph(self) → ORSModel.ors.Node

Returns a copy of the node, including its graph.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Returns:: output (ORSModel.ors.Node) – a new node (a Node)

detachChild(self, anINode: ORSModel.ors.Node) → bool

Detaches a child node.

Parameters:: anINode (ORSModel.ors.Node) – the node to detach (a Node)
Returns:: output (bool) – true if child was detached, false otherwise

getAllChildrenNodes(self) → ORSModel.ors.List

Returns a flattened list of the child hierarchy of the node.

Note

The child hierarchy is flattened.

Note

Expect a depth first search ordering of the nodes.

Returns:: output (ORSModel.ors.List) – a list of all nodes below the node (a List)

getAllChildrenOfClass(self, pProgId: str) → ORSModel.ors.List

Returns all the nodes of the specified class found in the child hierarchy.

Note

Result will be an empty list if no match is found.

Note

The search is done depth-first.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (a List)

getAllChildrenOfClassReachableByRenderer(self, pProgId: str) → ORSModel.ors.List

Returns a flattened list of all the child nodes, of the given class, that are renderable.

Note

The list contains only Managed objects (they will need to be typecast to the appropriate class).

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of all child nodes that can be rendered (an List)

getAllParentNodes(self) → ORSModel.ors.List

Returns a flattened list of the parent hierarchy of the node.

Note

The parent hierarchy is flattened.

Note

Expect a depth first search ordering of the nodes.

Returns:: output (ORSModel.ors.List) – a list of all nodes above the node (an List)

getAllParentsOfClass(self, pProgId: str) → ORSModel.ors.List

Returns all the nodes of the specified class found in the parent hierarchy.

Note

Result will be an empty list if no match is found.

Note

The search is done depth-first.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (an List)

getChildWithGUID(self, aGUID: str) → ORSModel.ors.Node

Gets an immediate child node with the given GUID.

Note

Only immediate children are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: aGUID (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Node) – a child node if found (a Node), none() otherwise

getChildWithTitle(self, aTitle: str) → ORSModel.ors.Node

Gets an immediate child node with the given title.

Note

Only immediate children are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: aTitle (str) – a string (a string)
Returns:: output (ORSModel.ors.Node) – a child node if found (a Node), none() otherwise

getChildrenNodes(self) → ORSModel.ors.List

Returns the list of immediate child nodes.

Returns:: output (ORSModel.ors.List) – a list of nodes (an List)

getChildrenOfClass(self, pProgId: str) → ORSModel.ors.List

Returns the nodes of the specified class found in the immediate children.

Note

Result will be an empty list if no match is found.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (an List)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirstChildOfClass(self, pProgId: str) → ORSModel.ors.Node

Returns the first object of the specified class found in the child hierarchy.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if one exists (a Node), none() otherwise

getFirstChildOfClassAndPrivateTitle(self, pProgId: str, privateTitle: str) → ORSModel.ors.Node

Searches the hierarchy for a child node with the specified class and private title.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – the name of the class to test against (a string)
privateTitle (str) – some text (a string)

Returns:

output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getFirstFrameTowardsNode(self, anINode: ORSModel.ors.Node) → ORSModel.ors.ReferenceFrame

Gets the first frame found going up the hierarchy towards a given object.

Parameters:: anINode (ORSModel.ors.Node) – the target node (an Node)
Returns:: output (ORSModel.ors.ReferenceFrame) – a frame (an ReferenceFrame) or none if no frame is found

getFirstNodeWithClassNameTowardsNode(self, pProgId: str, anINode: ORSModel.ors.Node) → ORSModel.ors.Node

Searches the hierarchy for a parent node with the specified class toward a specific parent nopde.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – the name of the class to test against (a string)
anINode (ORSModel.ors.Node) – a target node

Returns:

output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getFirstParentOfClass(self, pProgId: str) → ORSModel.ors.Node

Returns the first object of the specified class found in the parent hierarchy.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if one exists (a Node), none() otherwise

getFirstParentOfClassAndPrivateTitle(self, pProgId: str, privateTitle: str) → ORSModel.ors.Node

Searches the hierarchy for a parent node with the specified class and private title.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – the name of the class to test against (a string)
privateTitle (str) – some text (a string)

Returns:

output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getFrameTransformationFromNode(self, towardNode: ORSModel.ors.Node, pTimeStep: int) → ORSModel.ors.Matrix4x4

Parameters:

towardNode (ORSModel.ors.Node) –
pTimeStep (int) –

Returns:

output (ORSModel.ors.Matrix4x4) –

getImmediateChildOfClass(self, pProgId: str) → ORSModel.ors.Node

Searches for a child node with the specified class.

Note

Only the immediate children are searched, not the hierarchy.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getImmediateParentOfClass(self, pProgId: str) → ORSModel.ors.Node

Searches for a parent node with the specified class.

Note

Only the immediate parents are searched, not the hierarchy.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getImmediateParentWithGUID(self, pGUID: str) → ORSModel.ors.Node

Gets a parent node with the given GUID.

Note

Only immediate parents are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: pGUID (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Node) – a parent node if found (a Node), none() otherwise

getIsNodeOneOfMyAscendants(self, anINode: ORSModel.ors.Node) → bool

Checks to see if a specified node is in the parent hierarchy of the node.

Note

The parent hierarchy is searched in its entirety for the specified node.

Note

The search is conducted depth-first.

Parameters:: anINode (ORSModel.ors.Node) –
Returns:: output (bool) – true if the specified node in the parent hierarchy, false otherwise

getIsNodeOneOfMyDescendants(self, anINode: ORSModel.ors.Node) → bool

Checks to see if a specified node is in the child hierarchy of the node.

Note

The child hierarchy is searched in its entirety for the specified node.

Note

The search is conducted depth-first.

Parameters:: anINode (ORSModel.ors.Node) –
Returns:: output (bool) – true if the specified node in the child hierarchy, false otherwise

getMaxTSizeOfChilden(self) → int

Get Maximum T Size of all children node of this node.

Returns:: output (int) –

getParentNodes(self) → ORSModel.ors.List

Gets the immediate parent nodes.

Returns:: output (ORSModel.ors.List) – a list of nodes (a List)

getParentWithGUID(self, pGUID: str) → ORSModel.ors.Node

Gets a parent node (from the hierarchy) with the given GUID.

Note

The whole parent hierarchy is searched.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: pGUID (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Node) – a parent node if found (a Node), none() otherwise

getParentsOfClass(self, pProgId: str) → ORSModel.ors.List

Returns the nodes of the specified class found in the immediate parents.

Note

Result will be an empty list if no match is found.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (a List)

getVisual(self) → ORSModel.ors.Visual

Returns:: output (ORSModel.ors.Visual) – the visual of a model (a Visual)

isVisibleInView(view: View) → bool

Gets the visibility of the receiver in a given view.

Parameters:: view (ORSModel.ors.View) – The current view
Returns:: output (bool) – true if the receiver is visible, false otherwise

none() → Node

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Node) –

propagateChildrenNodesOrganizationDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsChildrenNodesOrganizationDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateDataDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsDataDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateDirty(self, dirtyFlag: str, includeSelf: bool = False)

Causes a dirty message to be sent to all children nodes.

Note

See ORS_def.h for default dirty flag (ex: ORSDataDirty).

Note

A dirty message has different results for different objects, but generally causes a refresh on the data.

Note

Message propagation is done depth-first.

Parameters:

dirtyFlag (str) – a string dirty flag (a string)
includeSelf (bool) – should set this dirty (a bool)

propagateGeometryDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsGeometryDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateHighlightDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsHighlightDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagatePropertyDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsPropertyDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateVisibilityDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsVisibilityDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

refresh(): Refreshes the views related to the current object

refreshAll2DParentViews(self): Causes all 2D views in the parent hierarchy of the node to be refreshed.

refreshAll2DParentViewsIfVisible(self): Causes all 2D views in the parent hierarchy of the node to be refreshed if it is a model and it visuals are visible in the views.

refreshAll3DParentViews(self): Causes all 3D views in the parent hierarchy of the node to be refreshed.

refreshAll3DParentViewsIfVisible(self): Causes all 3D views in the parent hierarchy of the node to be refreshed if it is a model and it visuals are visible in the views.

refreshAllParentViews(self): Causes all views in the parent hierarchy of the node to be refreshed.

refreshAllParentViewsIfVisible(self): Causes all views in the parent hierarchy of the node to be refreshed if it is a model and it visuals are visible in the views.

setAllowRenderingInAllParentViews(self, bValue: bool)

Allows or prevents rendering in the views affected by a node.

Parameters:: bValue (bool) – true to allow rendering, false to disallow it.

switchOrderOfPrecedenceOfChildrenNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool

Rearranges the order of child nodes.

Note

When child nodes are not in the desired order, they can be switched with this method (for example, the order in which they are rendered can be undesired).

Note

Both nodes are swapped in the list of nodes. For example, if nodes are A B C D and this call is made switchOrderOfPrecedenceOfChildrenNodes(A, C), the nodes are then in this order: C B A D.

Note

This method dives down in the child hierarchy until it finds a node where both arguments appear, then performs the switch at that level.

Parameters:

anINode1 (ORSModel.ors.Node) – a child node (a Node)
anINode2 (ORSModel.ors.Node) – a child node (a Node)

Returns:

output (bool) – true if successful, false otherwise

switchOrderOfPrecedenceOfParentNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool

Rearranges the ordering of immediate parent nodes.

Note

When parent nodes are not in the desired order, they can be switched with this method.

Note

Both nodes are swapped in the list of nodes. For example, if nodes are A B C D and this call is made switchOrderOfPrecedenceOfParentNodes(A, C), the nodes are then in this order: C B A D.

Note

This method acts only on immediate parent nodes, not the entire parent hierarchy.

Parameters:

anINode1 (ORSModel.ors.Node) – a parent node (a Node)
anINode2 (ORSModel.ors.Node) – a parent node (a Node)

Returns:

output (bool) – true if successful, false otherwise

Managed¶

class ORSModel.ors.Managed(*args, **kwargs)

Bases: ORSBaseClass

An abstract class that implements all the default behavior of managed objects.

addCallbackToEvent(self, anEventName: str, sCallbackName: str, callbackData: int) → bool

Adds a callback subscription to an event.

Note

The callback name for a given event needs to be unique for that event, i.e. no two callbacks for a given event can have the same name.

Parameters:

anEventName (str) – name of the event to subscribe to (a string)
sCallbackName (str) – callback name (a string)
callbackData (int) – a pointer to a ORS_EVENT_CALLBACK_INFO structure

Returns:

output (bool) – true if subscription succeeded, false otherwise

addToDeleteSet(self, anIObject: ORSModel.ors.Managed)

Add an object to the delete set.

Note

All objects have a delete set, which designates those objects that should also be deleted when the receiver gets deleted.

Parameters:: anIObject (ORSModel.ors.Managed) – an object (a Managed)

addToSelection(contextInstance)

Adds the instance to the selection of a context

Parameters:: contextInstance (plugin instance) – context instance

Note

Only representable object can be selected

applyPreferences(): Helper for setting the attribute of the object following the preferences

atomicLoad(sFilename: str, bPreserveIdentity: bool) → Managed

Creates an object from a file where an object was saved.

Parameters:

sFilename (str) – path of the file to load
bPreserveIdentity (bool) – if true, preserves the identity of the object, false otherwise

Returns:

output (Managed) – a managed object, or none() if the load fails

atomicLoadFrom(self, anXML: str)

Loads an object from an XML string.

Parameters:: anXML (str) – an XML (a string)

Managed.atomicLoadFrom(self, buffer: bytes, nBytes: int)

Loads an object from a memory buffer. Used for python pickling.

Parameters:

buffer (bytes) – the buffer
nBytes (int) – the number of bytes in the buffer (a uint64_t)

Managed.atomicLoadFrom(self, stream: ORSModel.ors.Stream) -> int

Loads an object from a stream (using callback).

Parameters:: stream (ORSModel.ors.Stream) – the stream to read data from
Returns:: output (int) – 0 if successful, otherwise an error code

atomicLoadSpecificNode(self, aFilename: str, aXPathOfTheNodeToLoad: str) → bool

Loads an object from a file containing several objects.

Parameters:

aFilename (str) – The file name, including entire path (a string)
aXPathOfTheNodeToLoad (str) – The XPath specification to find the node

Returns:

output (bool) – true if node was found and loaded, false otherwise

atomicSave(self, aFilename: str, isTemporary: bool = False, iCompressionEngine: int = 1) → int

Saves the object to a file.

Parameters:

aFilename (str) – path of the file to save
isTemporary (bool) – if true, try to keep file in memory
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if successful, otherwise an error code

atomicSaveToLegacyFormat(self, aFilename: str, isTemporary: bool = False, iCompressionEngine: int = 1) → int

Saves the object to a file in the legacy (2022.2) format.

Parameters:

aFilename (str) – path of the file to save
isTemporary (bool) – if true, try to keep file in memory
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if successful, otherwise an error code

atomicSaveToStream(self, stream: ORSModel.ors.Stream, iCompressionEngine: int = 1) → int

Saves the object to a stream (through callback).

Parameters:

stream (ORSModel.ors.Stream) – stream object to save current object in
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if successful, otherwise an error code

copy(self) → ORSModel.ors.Managed

Returns a copy of the managed.

Note

Only the immediate attributes of the managed are copied. The graph surrounding the new managed is the same one as the source managed.

Note

You can type the return value of this method to any subclass of Managed, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Returns:: output (ORSModel.ors.Managed) – a new managed (a Managed)

createScalarValuesCollection(self): method createScalarValuesCollection

deleteObject(self): Explicitly deletes the core object wrapped by this Interface object.

deleteObjectAndAllItsChildren(self): Explicitly deletes the core object wrapped by this Interface object, along with all its children.

ensureInitialization(self): This is for the Python interface.

getAllGroupsContaining(self, anIObject: ORSModel.ors.Managed) → ORSModel.ors.List

Gets all the groups that contain the given object.

Parameters:: anIObject (ORSModel.ors.Managed) –
Returns:: output (ORSModel.ors.List) –

getAllInstancesOf(pProgId: str) → ORSModel.ors.List

Gathers all existing objects of the specified class.

Parameters:: pProgId (str) –
Returns:: output (ORSModel.ors.List) –

getAllObjectsOfClassAndPrivateTitle(pProgId: str, pPrivateTitle: str) → ORSModel.ors.List

Gathers all existing objects of the specified class, that have a matching private title.

Parameters:

pProgId (str) – name of the class (a string)
pPrivateTitle (str) – private title to search for (a string)

Returns:

output (ORSModel.ors.List) – all the objects that match the search criteria (a List)

getAllObjectsOfClassAndTitle(pProgId: str, pTitle: str) → ORSModel.ors.List

Gathers all existing objects of the specified class, that have a matching title.

Parameters:

pProgId (str) – name of the class (a string)
pTitle (str) – title to search for (a string)

Returns:

output (ORSModel.ors.List) – all the objects that match the search criteria (a List)

getAllObjectsOfClassAndUserData(pProgId: str, userDataKey: str, userDataValue: str) → ORSModel.ors.List

Gathers all existing objects of the specified class, that have a matching user data.

Parameters:

pProgId (str) – name of the class (a string)
userDataKey (str) – key of the user data (a string)
userDataValue (str) – value to look for (a string)

Returns:

output (ORSModel.ors.List) – all the objects that match the search criteria (a List)

getAllRepresentableInstancesOf(pProgId: str) → ORSModel.ors.List

Gathers all existing objects of the specified class that are representable.

Parameters:: pProgId (str) –
Returns:: output (ORSModel.ors.List) –

getAllRepresentableObjects() → ORSModel.ors.List

Gets all the representable objects of the world.

Returns:: output (ORSModel.ors.List) – a list containing all the representable objects

getAtomicTextRepresentation(self, bSelfContained: bool) → str

Retrieves the object’s atomic text representation.

Parameters:: bSelfContained (bool) –
Returns:: output (str) –

getAutoDelete(self) → bool

Gets the autodelete value.

See also

ORSModel.ors.Managed.setAutoDelete()

Returns:: output (bool) –

getBinaryUserInfo(self, pTag: str)

Retrieves a user defined binary value. Typed as void* for sip, but it’s in reality an unsigned char*.

Note

If the key doesn’t exist, nullptr is returned

Parameters:: pTag (str) – key of the data (a string)

getBinaryUserInfoSize(self, pTag: str) → int

Retrieves the size of a user defined binary value.

Note

If the key doesn’t exist, 0 is returned

Parameters:: pTag (str) – key of the data (a string)
Returns:: output (int) – the size of the data (a uint32_t)

getCallbacksEnabled(self) → bool

Queries the object to know if its callbacks are enabled or disabled.

Returns:: output (bool) – true if callbacks are enabled, false otherwise

getChildrenNodesOrganizationDirtySignature()

Gets the current dirty signature for the flag OrsChildrenNodesOrganizationDirty

Returns:: childrenNodesOrganizationDirtySignature (int) – the dirty signature

getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:: output (str) – the class name (a string)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getCreationTime(self) → int

Returns the time Number of seconds since Jan 1 2000 of creation of this object.

Returns:: output (int) – a uint32_t

getDataChecksum(self) → str

Returns the computed checksum of the data.

Returns:: output (str) –

getDataDirtySignature()

Gets the current dirty signature for the flag OrsDataDirty

Returns:: dataDirtySignature (int) – the dirty signature

getDirtySignature(self, dirtyFlag: str) → int

Gets the current dirty signature.

Note

Objects can be dirty for several aspects, see the ors_def.h file for the different dirty aspects.

Parameters:: dirtyFlag (str) – dirty flag name (a string, see note below)
Returns:: output (int) – dirty signature (a uint64_t)

getEntireDirtySignature(self) → int

Gets the current dirty signature for all aspects, added up.

Note

Objects can be dirty for several aspects, see the ors_def.h file for the different dirty aspects.

Returns:: output (int) – entire dirty signature (a uint64_t)

getEventCallbackEnabled(self, sEventName: str, sCallbackName: str) → bool

Gets the enabled state of a callback subscription to an event.

Parameters:

sEventName (str) – event name (a string)
sCallbackName (str) – callback name (a string)

Returns:

output (bool) – true if callback is enabled, false if disabled or if the callback subscription did not exist

getGUID(self) → str

Retrieves the GUID of the core object.

Note

The GUID is the unique identifier of the object. No two objects can have the same GUID. Once you have an object’s GUID, at any time you can obtain a reference to that object via its GUID, given that the object is still alive.

Returns:: output (str) –

getGeometryDirtySignature()

Gets the current dirty signature for the flag OrsGeometryDirty

Returns:: geometryDirtySignature (int) – the dirty signature

getHasCallbacksForEvent(self, anEventName: str) → bool

Checks if the receiver has any callbacks for an event.

Parameters:: anEventName (str) – name of the event (a string)
Returns:: output (bool) – true if callbacks exist for the event, false otherwise

getHighlightDirtySignature()

Gets the current dirty signature for the flag OrsHighlightDirty

Returns:: highlightDirtySignature (int) – the dirty signature

getIsDirty(self, dirtyFlag: str) → bool

Gets if the object is dirty for a specific dirty flag.

Parameters:: dirtyFlag (str) – dirty flag name (a string, see note below)
Returns:: output (bool) – true if object is dirty, false otherwise

getIsDirtyAnyDirtyFlag(self) → bool

Gets if the object is dirty for any of the dirty flags.

Returns:: output (bool) – true if object is dirty, false otherwise

getIsEqualTo(self, aManaged: ORSModel.ors.Managed) → bool

Checks if the two objects are equal.

Parameters:: aManaged (ORSModel.ors.Managed) – an object to compare with (a Managed)
Returns:: output (bool) – true if the receiver and the argument are equal (class dependent), false otherwise

getIsIdentityPreservedForPickling(self) → bool

Returns True if the GUID is preserved when pickling and unpickling an object.

Returns:: output (bool) – Returns True if the GUID is preserved when pickling and unpickling an object

getIsInDeleteSet(self, anIObject: ORSModel.ors.Managed) → bool

Gets if an object is included in the receiver delete set.

Note

The delete set is a list of objects that are to be deleted when the receiver is deleted.

Parameters:: anIObject (ORSModel.ors.Managed) – object to look for in the receiver delete set (a Managed)
Returns:: output (bool) – true if the object is in the delete set of the receiver, false otherwise

getIsInstanceOf(self, pProgId: str) → bool

Queries the object to know if it is an instance of a certain class.

Parameters:: pProgId (str) –
Returns:: output (bool) –

getIsRepresentable(self) → bool

Queries the object to know if it is representable.

Returns:: output (bool) –

getIsSameObjectAs(self, anObject: ORSModel.ors.Managed) → bool

Checks to see if the receiver wraps the same underlying object as the supplied argument.

Parameters:: anObject (ORSModel.ors.Managed) – an object to compare with (a Managed)
Returns:: output (bool) – true if underlying object is the same for both the receiver and the argument, false otherwise

getIsToBeKeptAliveUntilExit(self) → bool

Queries the object to know if it is permanent for the life of the application.

Note

Permanent objects survive a new session, i.e. they live until the application is terminated.

Returns:: output (bool) – true if object is permanent, false otherwise

getIsToBeSaved(self) → bool

Queries the object to know if it should be saved in a session file.

Returns:: output (bool) – true if object should be saved, false otherwise

getMetadataChecksum(self) → str

Returns the computed checksum of the metadata.

Returns:: output (str) –

getObjectWithGUID(guid: str) → ORSModel.ors.Managed

Retrieves an object from its GUID.

Parameters:: guid (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Managed) – An object or none if object is not found

getObjectWithGUIDasPointer(guid: str) → ORSModel.ors.Managed

Retrieves an object from its GUID.

Parameters:: guid (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Managed) – An object or nullptr if object is not found

getPrivateTitle(self) → str

Gets the private title of the object.

Note

The private title is never shown in the application, but is a means by which an object can be found (getAllObjectsOfClassAndPrivateTitle for example).

Returns:: output (str) – private title of the object (a string)

getPropertyDirtySignature()

Gets the current dirty signature for the flag OrsPropertyDirty

Returns:: propertyDirtySignature (int) – the dirty signature

getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:: output (str) – The object’s representation (a string)

getReferenceCount(self) → int

Returns the count of references to the object.

Returns:: output (int) – the count of references (an int)

getScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

method getScalarValuesCollection

Returns:: output (ORSModel.ors.ScalarValuesCollection) –

getTitle(self) → str

Gets the title of the object.

Returns:: output (str) – the title (a string)

getUserInfo(self, pTag: str) → str

Retrieves a user defined value.

Note

If the key doesn’t exist an empty string is returned.

Parameters:: pTag (str) – key of the data (a string)
Returns:: output (str) – the data (a string)

getUserInfoAsArray(self) → ORSModel.ors.ArrayString

Retrieves the user info as a string array.

Note

The user info data is flattened into an array of string pairs, for the key and the value.

Returns:: output (ORSModel.ors.ArrayString) – the data (an ArrayString, see note below)

getUserInfoAsDictionary()

User info copy of Managed in a easy way for manipulation

return a copy of the object user info as a dictionary

getUserInfoMatchingPattern(self, pattern: str, case_sensitive_search: bool) → List[str]

Searches the user info dictionary based on a pattern matching.

Note

The pattern matching is done via regex.

Parameters:

pattern (str) – a search pattern (a string)
case_sensitive_search (bool) – true to search case-sensitive, false otherwise (a bool)

Returns:

output (List[str]) – a list of keys and values pairs, for all matching keys (a list of strings)

getVisibilityDirtySignature()

Gets the current dirty signature for the flag OrsVisibilityDirty

Returns:: visibilityDirtySignature (int) – the dirty signature

isManaged(self) → bool

Returns:: output (bool) –

isNone(self) → bool

Checks if the underlying core object is None.

Note

Interface objects hold references to core objects, so this method checks to see if a core object is truly referred to.

Returns:: output (bool) – true if the core object is non-existent, false otherwise.

isNotNone(self) → bool

Checks if the underlying core object is not None.

Note

Interface objects hold references to core objects, so this method checks to see if a core object is truly referred to.

Returns:: output (bool) – true if the core object is existent, false otherwise.

none() → Managed

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Managed) –

publish(): Sets an object as representable and notifies the Dragonfly UI of a new available object

removeBinaryUserInfo(self, pTag: str)

Removes a user defined binary value.

Parameters:: pTag (str) – key name of the binary value (a string)

removeCallbackFromEvent(guid: str, sEventName: str, sCallbackName: str, bRemoveInDeletedObject: bool) → bool

Removes a callback subscription to an event.

Parameters:

guid (str) – object GUID (a string)
sEventName (str) – name of the callback event (a string)
sCallbackName (str) – name of the callback (a string)
bRemoveInDeletedObject (bool) – if true, the callback will be removed from the object even if that object is in the process of being deleted (a boolean)

Returns:

output (bool) – true callback existed, false otherwise

removeFromDeleteSet(self, anIObject: ORSModel.ors.Managed)

Remove an object from the delete set.

Note

The delete set is a list of objects that are to be deleted when the receiver is deleted.

Parameters:: anIObject (ORSModel.ors.Managed) – object to be removed from the delete set (a Managed)

removeUserInfo(self, pTag: str)

Removes a user defined value.

Parameters:: pTag (str) – key of the data (a string)

selectExclusively(contextInstance)

Selects only the current instance for a context

Parameters:: contextInstance (plugin instance) – context instance

Note

Only representable object can be selected

setAsTemporaryObject(isTemporaryObject=True)

Helper for setting useful properties when marking an object as a (non-)temporary object.

Parameters:: isTemporaryObject (bool) – if True, the object will be set as temporary (not representable, not to be saved, callbacks disabled). Otherwise, these properties are set as the opposite.

setAutoDelete(self, value: bool)

When set to true, the interface object will call deleteObject on its core object when it is being deleted.

Parameters:: value (bool) –

setBinaryUserInfo(self, pTag: str, pValue: bytes, iDataSize: int)

Sets a user defined binary value.

Note

Objects can carry user defined data in the form of strings or binary data.

Parameters:

pTag (str) – key of the data (a string)
pValue (bytes) – the data (an unsigned char* buffer)
iDataSize (int) – the size of the data (a uint32_t)

setCallbacksEnabled(self, enabled: bool)

Sets the object’s callbacks to be enabled or not.

Note

When an object’s callbacks are disabled, absolutely no callbacks are triggered from the receiver.

Parameters:: enabled (bool) – true to enable callbacks, false otherwise

setChildrenNodesOrganizationDirty(): Calls for a setDirty with the flag OrsChildrenNodesOrganizationDirty

setDataDirty(): Calls for a setDirty with the flag OrsDataDirty

setDirty(self, dirtyFlag: str)

Sets the object as being dirty for a given aspect.

Note

A dirty object is an object that has changed, giving its observers a chance to refresh their view on the object. Several aspects of an object can be dirty, see ORS_def.h for dirty signature flags.

Parameters:: dirtyFlag (str) – dirty flag name (a string)

setEventCallbackEnabled(self, sEventName: str, sCallbackName: str, bValue: bool) → bool

Enables/disables a callback subscription to an event.

Note

Works for all callback types (object, class and global)

Parameters:

sEventName (str) – event name (a string)
sCallbackName (str) – callback name (a string)
bValue (bool) – true to enable the callback, false to disable it

Returns:

output (bool) – true if callback subscription existed, false otherwise

setGeometryDirty(): Calls for a setDirty with the flag OrsGeometryDirty

setHighlightDirty(): Calls for a setDirty with the flag OrsHighlightDirty

setIdentityIsPreservedForPickling(self, value: bool)

Set to True if the GUID is to be preserved when pickling and unpickling an object.

Parameters:: value (bool) –

setIsNotDirty(self): Sets the object as not being dirty for all dirty flags.

setIsRepresentable(self, isRepresentable: bool)

Sets the object to be representable or not.

Note

Non representable objects don’t appear in lists and such, the implicit meaning is that these objects are transient and temporary.

Parameters:: isRepresentable (bool) – true to make the object representable, false otherwise

setIsToBeKeptAliveUntilExit(self, pFlag: bool)

Sets the object to be permanent for the life of the application.

Note

Permanent objects survive a new session, i.e. they live until the application is terminated.

Parameters:: pFlag (bool) – true to make the object permanent, false otherwise

setIsToBeSaved(self, pIsToBeSaved: bool)

Sets the object to be saved to session files or not.

Parameters:: pIsToBeSaved (bool) – true to cause the object to be saved to session files, false otherwise

setPrivateTitle(self, newPrivateTitle: str)

Sets the private title of the object.

Note

The private title can later be used to find a reference to that object, given that it’s still alive.

Parameters:: newPrivateTitle (str) – a title (a string)

setPropertyDirty(): Calls for a setDirty with the flag OrsPropertyDirty

setTitle(self, newVal: str)

Sets the title of the object.

Dirty flags: OrsPropertyDirty

Anonymize newVal:: True
Parameters:: newVal (str) – new title (a string)

setUserInfo(self, pTag: str, pValue: str)

Parameters:

pTag (str) –
pValue (str) –

setUserInfoFromDictionary(aDic)

Add key value pair to the user Info of the Object. an str call are done on the key and values to insure that we respect the UserInfo protocol of Managed Object

Parameters:: aDic (dict) – a dictionary of information to add to the user information

setVisibilityDirty(): Calls for a setDirty with the flag OrsVisibilityDirty

switchAvailabilityToContext(oldContextID, newContextID)

Switches the availability of the object from an old context to a new context. This will be done only if the old context ID is found in the set of available contexts and the new context ID is not already in the set of available contexts. The availability for all other contexts remains unchanged.

The arguments oldContextID and newContextID are used as strings instead of plugin instances to support the situation where the old or new context is not existing (for example, to perform a copy of the objects).

Parameters:

oldContextID (str) – old context ID
newContextID (str) – new context ID

triggerClassEvent(self, sEventName: str) → bool

Triggers a class event.

Parameters:: sEventName (str) –
Returns:: output (bool) –

unpublish(): Sets an object as non-representable and notifies the Dragonfly UI of a loss of the availability of the object.

unselect(contextInstance)

Unselects the instance for a context

Parameters:: contextInstance (plugin instance) – context instance

ORSBaseClass¶

class ORSModel.ors.ORSBaseClass

An abstract class from which all objects issued from the ORS Core Library inherit.

getPythonTraceBack() → List[str]

Set the python traceback for a call from python.

Returns:: output (List[str]) –

isManaged(self) → bool

Returns:: output (bool) –

isNone(self) → bool

Returns:: output (bool) –

setPythonTraceBack(tb: List[str])

Set the python traceback for a call from python.

Parameters:: tb (List[str]) –

View¶

Inheritance diagram¶

Classes¶

View¶

Node¶

Managed¶

ORSBaseClass¶

Table of Contents

Previous topic

Next topic

This Page