OrientedPlane

Inheritance diagram

Classes

OrientedPlane

class ORSModel.ors.OrientedPlane

Bases: Shape2D

Oriented plane manipulation services.

copy(self) → ORSModel.ors.OrientedPlane

Gets a copy of the receiver.

Returns:

output (ORSModel.ors.OrientedPlane) – an oriented plane (an OrientedPlane)

createFromPythonRepresentation(aPythonRepresentation: str) → ORSModel.ors.OrientedPlane

Create aUnmanaged Object from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.OrientedPlane) –

from3PointsAndUp(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3, up: ORSModel.ors.Vector3)

Initializes the plane from 3 points and an up vector.

Note

The up vector must be perpendicular to the normal vector.

Parameters:

• point0 (ORSModel.ors.Vector3) – The first point (an Vector3)

• point1 (ORSModel.ors.Vector3) – The second point (an Vector3)

• point2 (ORSModel.ors.Vector3) – The third point (an Vector3)

• up (ORSModel.ors.Vector3) – The up vector (an Vector3)

fromPointAndNormalAndUp(self, point: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3, up: ORSModel.ors.Vector3)

Initializes the receiver from an origin point, a normal vector and an up vector.

Note

The up vector must be perpendicular to the normal vector.

Parameters:

• point (ORSModel.ors.Vector3) – The point of origin (an Vector3)

• normal (ORSModel.ors.Vector3) – The normal vector (an Vector3)

• up (ORSModel.ors.Vector3) – The up vector (an Vector3)

getA(self) → float

Gets the A plane value.

Returns:

output (float) – the A value (a double)

getB(self) → float

Gets the B plane value.

Returns:

output (float) – the B value (a double)

getC(self) → float

Gets the C plane value.

Returns:

output (float) – the C value (a double)

getCenter(self) → ORSModel.ors.Vector3

Gets the center position.

Returns:

output (ORSModel.ors.Vector3) – the center position (an Vector3)

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getD(self) → float

Gets the D plane value.

Returns:

output (float) – the D value (a double)

getDirection0(self) → ORSModel.ors.Vector3

Gets the orientedPlane right direction.

Note

The direction0 vector is normalized.

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3)

getDirection1(self) → ORSModel.ors.Vector3

Gets the orientedPlane up direction.

Note

The direction0 vector is normalized.

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3)

getDirection2(self) → ORSModel.ors.Vector3

Gets the orientedPlane normal direction.

Note

The direction0 vector is normalized.

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3)

getDistanceFromOrientedPlane(self, orientedPlane: ORSModel.ors.OrientedPlane) → float

Gets the distance from the provided plane to the receiver.

Parameters:

orientedPlane (ORSModel.ors.OrientedPlane) –

Returns:

output (float) – a distance (a double)

getDistanceFromPlane(self, plane: ORSModel.ors.Plane) → float

Returns the distance from the receiver to the provided plane.

Note

Returns 0 if the receiver is parallel with the provided plane.

Parameters:

plane (ORSModel.ors.Plane) – the plane (an Plane)

Returns:

output (float) – a distance (a double)

getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float

Returns the distance from the receiver to the provided point.

Parameters:

point (ORSModel.ors.Vector3) – the point (an Vector3)

Returns:

output (float) – a distance (a double)

getEulerAngles(self)

Returns the yaw, pitch, roll of the plane.

Returns:

• yaw (float) – yaw (a double)

• pitch (float) – pitch (a double)

• roll (float) – roll (a double)

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → ORSModel.ors.Vector3

Returns the vector representing the intersection with the provided line.

Parameters:

aLine (ORSModel.ors.Line) –

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if no intersection

getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → ORSModel.ors.Vector3

Returns the vector representing the intersection with the provided line segment.

Parameters:

aLineSegment (ORSModel.ors.LineSegment) –

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if no intersection

getIntersectionWithPlanes(self, plane1: ORSModel.ors.Plane, plane2: ORSModel.ors.Plane) → ORSModel.ors.Vector3

Returns the point of the intersection with the provided planes.

Parameters:

• plane1 (ORSModel.ors.Plane) –

• plane2 (ORSModel.ors.Plane) –

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if no intersection

getIsEqualTo(self, anOrientedPlane: ORSModel.ors.OrientedPlane) → bool

Parameters:

anOrientedPlane (ORSModel.ors.OrientedPlane) –

Returns:

output (bool) –

getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:

aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)

Returns:

output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)

getIsParallelWithOrientedPlane(self, orientedPlane: ORSModel.ors.OrientedPlane) → bool

Checks if the receiver is parallel with the provided oriented plane.

Parameters:

orientedPlane (ORSModel.ors.OrientedPlane) –

Returns:

output (bool) – TRUE if parallel, FALSE otherwise

getIsParallelWithPlane(self, plane: ORSModel.ors.Plane) → bool

Checks if the receiver is parallel with the provided plane.

Parameters:

plane (ORSModel.ors.Plane) – the plane (an Plane)

Returns:

output (bool) – TRUE if parallel, FALSE otherwise

getNormal(self) → ORSModel.ors.Vector3

Returns the normal of the plane.

Returns:

output (ORSModel.ors.Vector3) – A vector (an Vector3)

getPlane(self) → ORSModel.ors.Plane

Gets the plane represented by the receiver.

Returns:

output (ORSModel.ors.Plane) – a plane (an Plane)

getPointOnOrientedPlaneClosestToOrigin(self) → ORSModel.ors.Vector3

Returns the point on the receiver that is closest to the origin (0, 0, 0)

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3)

getProjectionOnPlane(self, point: ORSModel.ors.Vector3) → ORSModel.ors.Vector3

Returns the point provided projected on the receiver.

Parameters:

point (ORSModel.ors.Vector3) – the point (an Vector3)

Returns:

output (ORSModel.ors.Vector3) – the projected point (an Vector3)

getRight(self) → ORSModel.ors.Vector3

Gets the cross product of the normal and up vectors.

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3)

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → ORSModel.ors.OrientedPlane

Parameters:

• axisOfRotation (ORSModel.ors.Vector3) –

• rotationCenter (ORSModel.ors.Vector3) –

• angle (float) –

Returns:

output (ORSModel.ors.OrientedPlane) –

getTransformed(self, aTransformationMatrix: ORSModel.ors.Matrix4x4) → ORSModel.ors.OrientedPlane

Parameters:

aTransformationMatrix (ORSModel.ors.Matrix4x4) –

Returns:

output (ORSModel.ors.OrientedPlane) –

getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → ORSModel.ors.OrientedPlane

Parameters:

point (ORSModel.ors.Vector3) –

Returns:

output (ORSModel.ors.OrientedPlane) –

getUp(self) → ORSModel.ors.Vector3

Gets the up vector.

Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3)

none() → OrientedPlane

Returns:

output (OrientedPlane) –

rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float)

Applies a rotation to the receiver.

Note

The box is a right handed bounded referential.

Parameters:

• axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3)

• aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3)

• angleInRadian (float) – an angle in radian (a double)

setA(self, a: float)

Sets the A plane value.

Parameters:

a (float) – the A value (a double)

setB(self, b: float)

Sets the B plane value.

Parameters:

b (float) – the B value (a double)

setC(self, c: float)

Sets the C plane value.

Parameters:

c (float) – the C value (a double)

setCenter(self, pCenterVector: ORSModel.ors.Vector3)

Sets the center position.

Parameters:

pCenterVector (ORSModel.ors.Vector3) – a vector (an Vector3)

setD(self, d: float)

Sets the D plane value.

Parameters:

d (float) – the D value (a double)

setOrientedPlaneValue(self, a: float, b: float, c: float, d: float, upX: float, upY: float, upZ: float, centerX: float, centerY: float, centerZ: float)

Sets all the receiver value components.

Parameters:

• a (float) – the A parameter (a double)

• b (float) – the B parameter (a double)

• c (float) – the C parameter (a double)

• d (float) – the D parameter (a double)

• upX (float) – the up X component (a double)

• upY (float) – the up Y component (a double)

• upZ (float) – the up Z component (a double)

• centerX (float) – the center position X component (a double)

• centerY (float) – the center position Y component (a double)

• centerZ (float) – the center position Z component (a double)

setUp(self, upVector: ORSModel.ors.Vector3)

Sets the up vector.

Parameters:

upVector (ORSModel.ors.Vector3) – a vector (an Vector3)

translateToIncludePoint(self, point: ORSModel.ors.Vector3)

Parameters:

point (ORSModel.ors.Vector3) –

Shape2D

class ORSModel.ors.Shape2D

Bases: Shape

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

none() → Shape2D

Returns:

output (Shape2D) –

Shape

class ORSModel.ors.Shape

Bases: Unmanaged

Shape manipulation services.

copy(self) → ORSModel.ors.Unmanaged

Gets a copy of the receiver.

Returns:

output (ORSModel.ors.Unmanaged) – a shape

getCanBeUsedForProjection(self) → bool

Returns:

output (bool) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:

aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)

Returns:

output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → ORSModel.ors.Shape

Parameters:

• axisOfRotation (ORSModel.ors.Vector3) –

• rotationCenter (ORSModel.ors.Vector3) –

• angle (float) –

Returns:

output (ORSModel.ors.Shape) –

getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → ORSModel.ors.Shape

Parameters:

aMatrix (ORSModel.ors.Matrix4x4) –

Returns:

output (ORSModel.ors.Shape) –

none() → Shape

Returns:

output (Shape) –

rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float)

Applies a rotation to the receiver.

Note

The box is a right handed bounded referential.

Parameters:

• axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3)

• aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3)

• angleInRadian (float) – an angle in radian (a double)

transform(self, transformationMatrix: ORSModel.ors.Matrix4x4)

Applies a transformation to the receiver.

Note

The transformation can include: translation, rotation and scaling.

Parameters:

transformationMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSBaseClass

Abstract class for objects that are not managed by the core library. Unmanaged objects are transient objects.

atomicLoad(sFilename: str) → Unmanaged

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

Parameters:

sFilename (str) – path of the file to load

Returns:

output (Unmanaged) – an unmanaged object, or none() if the load fails

atomicSave(self, aFilename: str) → int

Saves the object to a file.

Parameters:

aFilename (str) – path of the file to save

Returns:

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

createFromPythonRepresentation(aPythonRepresentation: str) → ORSModel.ors.Unmanaged

Create aUnmanaged Object from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.Unmanaged) –

fromPythonRepresentation(self, aPythonRepresentation: str) → bool

Create aUnmanaged object from a Python string representation.

Parameters:

aPythonRepresentation (str) – a Python evaluable string representation (a string)

Returns:

output (bool) – true if parsing worked, false otherwise (a bool)

getClassName(self) → str

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

Returns:

output (str) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getDataChecksum(self) → str

Returns:

output (str) –

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) –

getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:

output (str) –

isNone(self) → bool

Checks if the receiver is none.

Returns:

output (bool) –

isNotNone(self) → bool

Checks if the receiver is not none.

Returns:

output (bool) –

none() → Unmanaged

Returns:

output (Unmanaged) –

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]) –