Circle

Inheritance diagram

Classes

Circle

class ORSModel.ors.Circle

Bases: Shape2D

Circle manipulation services.

copy(self) → ORSModel.ors.Circle

Copies aCircle.

Note

The copied Circle has the same equation as the source Circle.

Returns:

output (ORSModel.ors.Circle) – A new Circle (an Circle)

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

Create aCircle from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.Circle) –

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

Initializes theCircle from 3 points.

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)

fromNPointsLeastMeanSquares(self, aPointCollection: ORSModel.ors.SequenceableCollection, normal: ORSModel.ors.Vector3)

set a circle from a set of (at least 2) points.

Parameters:

• aPointCollection (ORSModel.ors.SequenceableCollection) – a collection containing the points coordinates

• normal (ORSModel.ors.Vector3) – a normalized normal vector to the plane in which to draw the circle

getArea(self) → float

Returns:

output (float) –

getCenter(self) → ORSModel.ors.Vector3

Returns the normal of theCircle.

Returns:

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

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

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

Parameters:

aLine (ORSModel.ors.Line) –

Returns:

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

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

Parameters:

aLineSegment (ORSModel.ors.LineSegment) –

Returns:

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

getIntersectionWithPlane(self, pPlane: ORSModel.ors.Plane) → ORSModel.ors.LineSegment

Parameters:

pPlane (ORSModel.ors.Plane) –

Returns:

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

getIsEqualTo(self, Circle: ORSModel.ors.Circle) → bool

Parameters:

Circle (ORSModel.ors.Circle) –

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)

getNormal(self) → ORSModel.ors.Vector3

Returns the normal of theCircle.

Returns:

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

getPlane(self) → ORSModel.ors.Plane

Returns:

output (ORSModel.ors.Plane) –

getRadius(self) → float

Returns:

output (float) –

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

Parameters:

• axisOfRotation (ORSModel.ors.Vector3) –

• rotationCenter (ORSModel.ors.Vector3) –

• angle (float) –

Returns:

output (ORSModel.ors.Circle) –

none() → Circle

Returns:

output (Circle) –

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)

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

Parameters:

aCenter (ORSModel.ors.Vector3) –

setNormal(self, aNormal: ORSModel.ors.Vector3)

Returns the normal of theCircle.

Parameters:

aNormal (ORSModel.ors.Vector3) –

setRadius(self, aRadius: float)

Parameters:

aRadius (float) –

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