Indexes

Marker3D (Object)

Represents a marker 3D.

Property Index

Fill
Returns or sets the marker 3D's filling status (1 the figure is filled, 0 the figure is not filled).
Frame
Returns or sets the marker 3D's framing status (1 the figure is framed, 0 the figure is not framed).
TextFont
Returns or sets the text's font for a marker 3D.
TextOrientation
Returns or sets the orientation of text.
TextSize
Returns or sets the text's size for a marker 3D.
Text
Returns or sets the text for a text marker 3D.
Type
Returns the type of the marker 3D.

Method Index

AddObject
Adds a link to an object.
CountObject
Returns the number of objects which are linked to the marker 3D.
GetObjectPositions
Retrieves the coordinates of the anchor point of the marker on the object.
GetTextPositions
Retrieves the coordinates of the positions of a text marker 3D.
ItemObject
Returns an object which is linked to the marker 3D using its index.
RemoveObject
Removes an object which is linked to the marker 3D using its index.
SetObjectPositions
Sets the coordinates of the anchor point of the marker on the object.
SetTextPositions
Sets the coordinates of the positions of a text marker 3D.
Update
Updates the the marker 3D: that is to take into account all modifications which occur since last update.

Properties


o Property Fill() As
Returns or sets the marker 3D's filling status (1 the figure is filled, 0 the figure is not filled).
Example:
This example retrieves the filling status of NewMarker3D marker 3D. 
    Dim status As Integer
    status = NewMarker3D.Fill
o Property Frame() As
Returns or sets the marker 3D's framing status (1 the figure is framed, 0 the figure is not framed).
Example:
This example retrieves the framing status of NewMarker3D marker 3D. 
    Dim status As Integer
    status = NewMarker3D.Frame
o Property TextFont() As
Returns or sets the text's font for a marker 3D.
Example:
This example retrieves the text's font of NewMarker3D marker 3D. 
    Dim font As String
    font = NewMarker3D.TextFont
o Property TextOrientation() As
Returns or sets the orientation of text.
Example:
This example retrieves the orientation of NewMarker3D marker 3D. 
    Dim orientation As CatMarkerTextOrientation
    orientation = NewMarker3D.TextOrientation
o Property TextSize() As
Returns or sets the text's size for a marker 3D.
Example:
This example retrieves the text's size of NewMarker3D marker 3D. 
    Dim size As Double
    size = NewMarker3D.TextSize
o Property Text() As
Returns or sets the text for a text marker 3D.
Example:
This example reads the text of NewMarker3D marker 3D. 
    Dim text As String
    text = NewMarker3D.Text
o Property Type() As (Read Only)
Returns the type of the marker 3D.
Example:
This example reads the type of NewMarker3D marker 3D. 
    Dim type As CatMarker3DType
    type = NewMarker3D.Type

Methods


o Sub AddObject( iObject)
Adds a link to an object.
Parameters:
iObject
The object to be linked.
Example:
This example links ThisProduct to the NewMarker3D marker 3D. 
    NewMarker3D.AddObject(ThisProduct)
o Func CountObject() As
Returns the number of objects which are linked to the marker 3D.
Example:
This example reads the number of objects in the marker3D NewMarker3D. 
    Dim number As Integer
    number = NewMarker3D.CountObject
o Sub GetObjectPositions( iIndex,
oCoordinates)
Retrieves the coordinates of the anchor point of the marker on the object.
Parameters:
iIndex
The index of the object in the marker 3D. The index of the first object is 1, and the index of the last object is CountObject.
oCoordinates
The coordinates of the anchor point
  • oCoordinates(0) is the X coordinate of the anchor point
  • oCoordinates(1) is the Y coordinate of the anchor point
  • oCoordinates(2) is the Z coordinate of the anchor point
Example:
This example retrieves the coordinates of the anchor in the NewMarker3D marker 3D. 
    Dim Coordinates (3)
    NewMarker3D.GetObjectPositions Coordinates
o Sub GetTextPositions( oCoordinates)
Retrieves the coordinates of the positions of a text marker 3D. The bottom-left corner of the text is anchored to a given point.
Returns:
The coordinates of the text anchor point
  • oCoordinates(0) is the X coordinate of the text anchor point
  • oCoordinates(1) is the Y coordinate of the text anchor point
  • oCoordinates(2) is the Z coordinate of the text anchor point
Example:
This example retrieves the coordinates of the text in the NewMarker3D marker 3D. 
    Dim Coordinates (2)
    NewMarker3D.GetTextPositions Coordinates
o Func ItemObject( iIndex) As
Returns an object which is linked to the marker 3D using its index.
Parameters:
iIndex
The index of the object in the marker 3D. The index of the first object is 1, and the index of the last object is CountObject.
Returns:
The retrieved object
Example:
This example retrieves in ThisObject the ninth object from the NewMarker3D marker 3D. 
    Dim ThisObject As Marker3D
    Set ThisObject = NewMarker3D.ItemObject(9)
o Sub RemoveObject( iIndex)
Removes an object which is linked to the marker 3D using its index.
Parameters:
iIndex
The index of the object in the marker 3D. The index of the first object is 1, and the index of the last object is CountObject.
Example:
This example removes the ninth object from the NewMarker3D marker 3D. 
    NewMarker3D.RemoveObject(9)
o Sub SetObjectPositions( iIndex,
iCoordinates)
Sets the coordinates of the anchor point of the marker on the object.
Parameters:
iIndex
The index of the object in the marker 3D. The index of the first object is 1, and the index of the last object is CountObject.
iCoordinates
The coordinates of the anchor point
  • oCoordinates(0) is the X coordinate of the anchor point
  • oCoordinates(1) is the Y coordinate of the anchor point
  • oCoordinates(2) is the Z coordinate of the anchor point
Example:
This example sets the coordinates of the anchor in the NewMarker3D marker 3D. 
    Dim Coordinates (3)
    NewMarker3D.SetObjectPositions Coordinates
o Sub SetTextPositions( iCoordinates)
Sets the coordinates of the positions of a text marker 3D.
Parameters:
iCoordinates
The coordinates of the text anchor point
  • oCoordinates(0) is the X coordinate of the text anchor point
  • oCoordinates(1) is the Y coordinate of the text anchor point
  • oCoordinates(2) is the Z coordinate of the text anchor point
Example:
This example sets the coordinates of the text in the NewMarker3D marker 3D. 
    Dim Coordinates (2)
    NewMarker3D.SetTextPositions Coordinates
o Sub Update()
Updates the the marker 3D: that is to take into account all modifications which occur since last update.
Example:
This example updates the NewMarker3D marker 3D. 
    NewMarker3D.Update

Copyright © 2006, Dassault Systèmes. All rights reserved.