com.anylogic.engine.presentation.Shape3DObject

All Implemented Interfaces:: com.anylogic.engine.internal.Child, Locatable2D, Locatable3D, AggregatableAnimationElement, HasLevel, LevelElement, SVGElement, UsdElement, Serializable, Cloneable

public class Shape3DObject
extends Shape3D
implements com.anylogic.engine.internal.Child

3D object shape loaded from COLLADA (.dae) file. Also visible on 2D animation (in the form of top-view).
This shape enables AnyLogic users to import ready-to-use 3D objects created in some third-party 3D graphics packets into their models.
COLLADA format is the XML-based file format for representing 3D computer graphics.

Author:: AnyLogic North America, LLC https://anylogic.com
See Also:: Serialized Form

Field Summary

Modifier and Type	Field	Description
`static final Object3DAxisOrder`	`XYZ_AXIS_ORDER`	Deprecated.
`static final Object3DAxisOrder`	`YZX_AXIS_ORDER`	Deprecated.
`static final Object3DAxisOrder`	`ZXY_AXIS_ORDER`	Deprecated.

Fields inherited from class com.anylogic.engine.presentation.Shape3D

UNKNOWN_NAME

Fields inherited from interface com.anylogic.engine.presentation.UsdElement

ID_NOT_SET

Constructor Summary

Constructor	Description
`Shape3DObject(Presentable presentable, boolean ispublic, double x, double y, double z, double rotation, double scale, String packagePrefix, String fileName, Object3DAxisOrder axisOrder, boolean applyShading, double topLeftX, double topLeftY, double width, double height)`	Deprecated. this constructor is deprecated and will be removed in future releases
`Shape3DObject(Presentable presentable, ShapeDrawMode drawMode, boolean ispublic, double x, double y, double z, double rotation, double scale, boolean autoScale, String packagePrefix, String fileName, Object3DAxisOrder axisOrder, boolean applyShading, double topLeftX, double topLeftY, double width, double height)`	Deprecated. this constructor is deprecated and will be removed in future releases
`Shape3DObject(Presentable presentable, ShapeDrawMode drawMode, boolean ispublic, double x, double y, double z, double rotation, double scale, boolean autoScale, String packagePrefix, String fileName, Object3DAxisOrder axisOrder, boolean applyShading, double topLeftX, double topLeftY, double width, double height, Long imageFileId, Pair<String,Color>... customColors)`	Deprecated. this constructor is deprecated and will be deleted in future releases
`Shape3DObject(Presentable presentable, ShapeDrawMode drawMode, boolean ispublic, double x, double y, double z, double rotation, double scale, boolean autoScale, String packagePrefix, String fileName, Object3DAxisOrder axisOrder, double topLeftX, double topLeftY, double width, double height)`	Constructs a 3D shape with specific attributes.
`Shape3DObject(Presentable presentable, ShapeDrawMode drawMode, boolean ispublic, double x, double y, double z, double rotation, double scale, boolean autoScale, String packagePrefix, String fileName, Object3DAxisOrder axisOrder, Object3DInternalLighting internalLighting, boolean ignoreSceneLights, double topLeftX, double topLeftY, double width, double height, Long imageFileId, boolean visible, Pair<String,Color>... customColors)`	Constructs a 3D shape with specific attributes.

Method Summary

Modifier and Type	Method	Description
`final Shape3DObject`	`clone()`	Creates and returns a copy of this shape (i.e.
`boolean`	`contains(double px, double py)`	Test if the shape contains the point with the given coordinates (relative to this shape's container, i.e.
`void`	`dispose()`	Releases resources allocated by this object, should be called on agent destroy.
`double`	`getAgentScalingFactor()`	Returns additional scaling factor for sizing accordingly to the Scale element on the Agent.
`Object3DAxisOrder`	`getAxisOrder()`
`String`	`getFilename()`	Returns the name of 3D object file
`String`	`getFilePath_xjal()`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`Presentable`	`getPresentable()`	Returns the Presentable object (`Agent` or `Experiment`) where this shape belongs to, or null.
`void`	`postSVGShapeSpecificAttributes(List<String> att, List<String> val, boolean publicOnly)`	Posts general properties specific to a particular shape class.
`void`	`restoreOwner(Object owner)`	Deprecated.
`void`	`setColor(String materialName, Color color)`	Changes custom color for the shape material with the given name. Current implementation updates object on the 3D scene only, it doesn't update the 2D picture - this will be implemented in future releases.

Methods inherited from class com.anylogic.engine.presentation.Shape3D

canHandleClick, getDrawMode, getScaleZ, getZ, getZOffset, setDrawMode, setPos, setPos, setPos, setRotation, setScale, setScale, setScaleZ, setZ

Methods inherited from class com.anylogic.engine.presentation.Shape

executeUserAction, findSVGElement, getGroup, getLevel, getName, getOrGenerateUSDId, getRotation, getScaleX, getScaleY, getSVGId, getUsdVersion, getX, getY, isJava2DSwingPresentation, isPublic_xjal, isSVGPresentation, isVisible, isVisibleCurrently, onAggregatorVisibilityChanged, onClick, randomPointInside, randomPointInside, removeSVGFromOwner, removeSVGImage, resetSVGState, setChangedUsdVersion, setLevel, setNextChangedUsdVersion, setPublic_xjal, setScale, setScaleX, setScaleY, setVisible, setX, setY, updateDynamicProperties, updateDynamicPropertiesStructural, updateSVGProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.anylogic.engine.markup.AggregatableAnimationElement

initializeInternal, postInitialize

Methods inherited from interface com.anylogic.engine.Locatable2D

getX, getY

Field Details

XYZ_AXIS_ORDER

@Deprecated
public static final Object3DAxisOrder XYZ_AXIS_ORDER

Deprecated.

YZX_AXIS_ORDER

@Deprecated
public static final Object3DAxisOrder YZX_AXIS_ORDER

Deprecated.

ZXY_AXIS_ORDER

@Deprecated
public static final Object3DAxisOrder ZXY_AXIS_ORDER

Deprecated.

Constructor Details

Shape3DObject

@Deprecated
public Shape3DObject(Presentable presentable,
 boolean ispublic,
 double x,
 double y,
 double z,
 double rotation,
 double scale,
 String packagePrefix,
 String fileName,
 Object3DAxisOrder axisOrder,
 boolean applyShading,
 double topLeftX,
 double topLeftY,
 double width,
 double height)

Deprecated.

this constructor is deprecated and will be removed in future releases

Shape3DObject

@Deprecated
public Shape3DObject(Presentable presentable,
 ShapeDrawMode drawMode,
 boolean ispublic,
 double x,
 double y,
 double z,
 double rotation,
 double scale,
 boolean autoScale,
 String packagePrefix,
 String fileName,
 Object3DAxisOrder axisOrder,
 boolean applyShading,
 double topLeftX,
 double topLeftY,
 double width,
 double height)

Deprecated.

this constructor is deprecated and will be removed in future releases

Shape3DObject

public Shape3DObject(Presentable presentable,
 ShapeDrawMode drawMode,
 boolean ispublic,
 double x,
 double y,
 double z,
 double rotation,
 double scale,
 boolean autoScale,
 String packagePrefix,
 String fileName,
 Object3DAxisOrder axisOrder,
 double topLeftX,
 double topLeftY,
 double width,
 double height)

Constructs a 3D shape with specific attributes.

Parameters:: presentable - the presentable object owning this object; drawMode - where to draw this shape: 2D, 3D or 2D+3D; ispublic - if true, the shape is visible on container's presentation; x - the x coordinate of the object; y - the y coordinate of the object; z - the z coordinate of the object; rotation - the rotation of the object in radians; scale - the scale of the object; autoScale - if true, shape will be additionally resized to match the scale of the agent this shape is located on. Please note that in this case generated 2D image file should be rendered using the final, multiplied scale; packagePrefix - the package name of original agent where this object is defined, formatted using '/' characters; with '/' character at the beginning and at the end; fileName - the name of the 3D object file; axisOrder - axis order of this figure, may be used for orientation correction for objects obtained from different 3D editors; topLeftX - the x coordinate of the top-left corner of XY-projection of object in local object coordinates; topLeftY - the y coordinate of the top-left corner of XY-projection of object in local object coordinates; width - the width of the XY-projection of object in local object coordinates; height - the height of the XY-projection of object in local object coordinates; imageFileId - internal id used to find generated png image; customColors - array of pairs: material name, color

Shape3DObject

@SafeVarargs
@Deprecated
public Shape3DObject(Presentable presentable,
 ShapeDrawMode drawMode,
 boolean ispublic,
 double x,
 double y,
 double z,
 double rotation,
 double scale,
 boolean autoScale,
 String packagePrefix,
 String fileName,
 Object3DAxisOrder axisOrder,
 boolean applyShading,
 double topLeftX,
 double topLeftY,
 double width,
 double height,
 Long imageFileId,
 Pair<String,Color>... customColors)

Deprecated.

this constructor is deprecated and will be deleted in future releases

Shape3DObject

@SafeVarargs
public Shape3DObject(Presentable presentable,
 ShapeDrawMode drawMode,
 boolean ispublic,
 double x,
 double y,
 double z,
 double rotation,
 double scale,
 boolean autoScale,
 String packagePrefix,
 String fileName,
 Object3DAxisOrder axisOrder,
 Object3DInternalLighting internalLighting,
 boolean ignoreSceneLights,
 double topLeftX,
 double topLeftY,
 double width,
 double height,
 Long imageFileId,
 boolean visible,
 Pair<String,Color>... customColors)

Constructs a 3D shape with specific attributes.

Parameters:: presentable - the presentable object owning this object; drawMode - where to draw this shape: 2D, 3D or 2D+3D; ispublic - if true, the shape is visible on container's presentation; x - the x coordinate of the object; y - the y coordinate of the object; z - the z coordinate of the object; rotation - the rotation of the object in radians; scale - the scale of the object; autoScale - if true, shape will be additionally resized to match the scale of the agent this shape is located on. Please note that in this case generated 2D image file should be rendered using the final, multiplied scale; packagePrefix - the package name of original agent where this object is defined, formatted using '/' characters; with '/' character at the beginning and at the end; fileName - the name of the 3D object file; axisOrder - axis order of this figure, may be used for orientation correction for objects obtained from different 3D editors; internalLighting - defines how the internal lights (which this 3D object may contain) will operate on the scene: turned off, lighting this 3D object only (self lighting), or lighting on the global level (like headlamp of the car).; ignoreSceneLights - allows to disable lighting of this 3D object by other lights located on the model scene - useful when 3D object contains internal lights and shouldn't be double-lighted.; topLeftX - the x coordinate of the top-left corner of XY-projection of object in local object coordinates; topLeftY - the y coordinate of the top-left corner of XY-projection of object in local object coordinates; width - the width of the XY-projection of object in local object coordinates; height - the height of the XY-projection of object in local object coordinates; imageFileId - internal id used to find generated png image; customColors - array of pairs: material name, color

Method Details

getFilename

public String getFilename()

Returns the name of 3D object file

Returns:: the name of 3D object file

setColor

public void setColor(String materialName,
 Color color)

Changes custom color for the shape material with the given name.
Current implementation updates object on the 3D scene only, it doesn't update the 2D picture - this will be implemented in future releases.

Parameters:: materialName - the name of the material. Please refer to Properties View of this 3D object in AnyLogic.; color - new color, or null to reset the color to default value
Since:: 8.3

getFilePath_xjal

@AnyLogicInternalAPI
public String getFilePath_xjal()

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

getAgentScalingFactor

public double getAgentScalingFactor()

Returns additional scaling factor for sizing accordingly to the Scale element on the Agent.