# GeometryAbcMesh#

(Abc Mesh)

No corresponding User page.

## Description#

Import an alembic mesh from a file. Supported format: abc.

## Public Attributes#

Type Name Visual Hint Description
string filename VISUAL_HINT_FILENAME_OPEN File path.
long pivot_mode VISUAL_HINT_DEFAULT Set the way pivot information is read in the file: using the baked matrix or individual attributes.
long frame VISUAL_HINT_DEFAULT Defines the value of the frame that will be used to evaluate the mesh.
long anim_frame_count VISUAL_HINT_DEFAULT Count of frames available in the file to animate the pivot
long deform_frame_count VISUAL_HINT_DEFAULT Count of frames available in the file to deform the geometry
long frame_offset VISUAL_HINT_DEFAULT Offset the time. If you set the value to 50 while the animation starts at frame 10, it then starts at frame 60.
long animation_behavior VISUAL_HINT_DEFAULT Set how the animation will loop.
bool force_animation_range VISUAL_HINT_DEFAULT
long[2] animation_range VISUAL_HINT_DEFAULT Start and end of the forced animation.
long deformation_behavior VISUAL_HINT_DEFAULT Set how the animation will be deformed.
bool force_deformation_range VISUAL_HINT_DEFAULT
long[2] deformation_range VISUAL_HINT_DEFAULT Start and end of the forced deformation.
long compression_mode VISUAL_HINT_DEFAULT Set whether data memory compression mode. Compression allows to save memory and should always be enabled. However in some very rare cases, it may slightly degrade the data. When this happens you can set the compression to Disable. If Compression is set to Automatic, compression is only performed if data degradation is minor. Automatic compression requires some extra processing which is why it is disabled by default.
long motion_blur_mode VISUAL_HINT_DEFAULT Specify which data is used to compute motion blur. Read Velocities (distance per second): read velocities from file and interpret them as distance units per second. Read Velocities (distance per frame): read velocities from file and interpret them as distance units per frame. Compute Velocities: compute velocities from actual geometric positions. Use Sub Positions: use sub-frame geometric positions, providing more accurate results at the expense of more memory usage.

## Inherited Public Attributes#

Type Name Visual Hint Description
double[3] translate VISUAL_HINT_DISTANCE Set the XYZ position of the item relative to its parent item.
double[3] rotate VISUAL_HINT_ANGLE Set the XYZ rotation of the item relative to its parent item.
double[3] scale VISUAL_HINT_SCALE Set the XYZ scaling of the item relative to its parent item.
double[3] shear VISUAL_HINT_SCALE Set the XYZ shear of the item relative to its parent item.
long rotation_order VISUAL_HINT_DEFAULT Specify on which order the Euler rotations are composed. By default Clarisse's uses YXZ
reference (SceneItem) parent VISUAL_HINT_DEFAULT Set the parent item of the item.
bool inherit_transform VISUAL_HINT_DEFAULT Does the current object inherits its parent transformation ?
long reference_frame VISUAL_HINT_FRAME Set the reference frame that defines the base transform and deformation state of the item. This reference is used when computing texture projections or when generating point cloud (in Global Base) on the base geometry.
object[] (Constraint) constraints VISUAL_HINT_DEFAULT Stack of constraint operators. Constraints like Target, Point, Orient... are applied to a Scene Item in order to drive the transformation of the item.
double[3] scale_pivot VISUAL_HINT_DISTANCE Set the coordinates of the scale pivot.
double[3] rotate_pivot VISUAL_HINT_DISTANCE Set the coordinates of the rotation pivot.
double[3] translate_offset VISUAL_HINT_DISTANCE Set the XYZ position of the pivot point of the item.
double[3] rotate_offset VISUAL_HINT_ANGLE Set the XYZ rotation of the pivot point of the item.
double[3] scale_offset VISUAL_HINT_SCALE Set the XYZ scaling of the pivot point of the item.
long rotation_offset_order VISUAL_HINT_DEFAULT Set the rotation axis mode.
bool display_visible VISUAL_HINT_DEFAULT Set whether the item is shown in the 3D View or not.
bool display_pickable VISUAL_HINT_DEFAULT Set whether the item is pickable in the 3D View or in the Image View.
long display_color VISUAL_HINT_DEFAULT Set the item color for constant or simple shading display in the 3D View.
double[3] display_custom_color VISUAL_HINT_COLOR Set the item custom color used for display in the 3D View when the Display Color attribute is set to Custom.
long visibility_mode VISUAL_HINT_DEFAULT Set how visibility attributes 'Display Visible' and 'Unseen By Renderer' are driven. In Use Project Preferences mode, the mode uses the project preference value. In Override mode, the attributes are set manually. In Use Property mode, the attributes are driven by a property (e.g. Alembic visibility property).
bool enable_motion_blur VISUAL_HINT_DEFAULT Set whether the renderer will do motion blur on the item or not.
long display_mode VISUAL_HINT_DEFAULT Define how the object is displayed in the 3D View.
long highlight_mode VISUAL_HINT_DEFAULT Define how the object is highlighted in the 3D View when selected.
reference (Material) override_material VISUAL_HINT_DEFAULT Setting a material here will set the specified material to all elements of the scene object. Ex: all shading groups of a geometry will have the same material. Ex: all elements of a combiner or a scatterer will have the same material.
bool matte_object VISUAL_HINT_DEFAULT Switch the object to 2D matte mode.
double[3] matte_color VISUAL_HINT_COLOR Set the color of the object in matte mode.
double matte_alpha VISUAL_HINT_PERCENTAGE Set the opacity of the object in matte mode. When the matte alpha is less than 100%, the object creates a hole in the layer as no transparency is evaluated.
long custom_id VISUAL_HINT_DEFAULT
double raytrace_offset VISUAL_HINT_DISTANCE Set the minimum distance for raytracing visibility. If the ray hit point distance from the ray source position is smaller than this value, then the geometry is not seen. Note: this attribute is used to prevent self intersection artifacts.
string shading_variables VISUAL_HINT_SCRIPT
bool unseen_by_renderer VISUAL_HINT_DEFAULT Set whether the object is hidden from the renderer or not.
bool unseen_by_camera VISUAL_HINT_DEFAULT Set whether the object is hidden from the camera (primary rays) or not.
bool unseen_by_rays VISUAL_HINT_DEFAULT Set whether the object is hidden from the raytraced shading effects like reflection/refraction (secondary rays) or not.
bool unseen_by_reflections VISUAL_HINT_DEFAULT Set whether the object is hidden from reflections or not.
bool unseen_by_refractions VISUAL_HINT_DEFAULT Set whether the object is hidden from refractions or not.
bool unseen_by_gi VISUAL_HINT_DEFAULT Set whether the object is hidden from global illumination or not.
bool unseen_by_sss VISUAL_HINT_DEFAULT Set whether the object is hidden from sub-surface scattering or not.
bool cast_shadows VISUAL_HINT_DEFAULT Set whether the object casts shadows or not.
bool receive_shadows VISUAL_HINT_DEFAULT Set whether the object receives cast shadows or not.
bool receive_self_shadows VISUAL_HINT_DEFAULT Set whether the object receives self shadows or not.
reference (Group) lights VISUAL_HINT_GROUP Specify the group of lights that illuminate this object. By default, scene objects are lit using the lights gathered by the 3D layer.
bool enable_emission_importance_sampling VISUAL_HINT_DEFAULT Specify whether emission importance sampling is enabled on the scene object. This attribute is ignored when emission importance sampling is disabled in the renderer.
long emission_sample_count VISUAL_HINT_SAMPLE_PER_PIXEL Override the number of emission samples allocated by the renderer when sampling the scene object.
long emission_texture_importance_sampling VISUAL_HINT_DEFAULT When None, no texture importance sampling is performed. When Color, Emission Color input textures of all materials assigned to the scene object are importance sampled. This mode should be used when only the Emission Color of the material is textured which is typically the case when using an HDR texture encoding both color and intensity. When Weight, Emission Weight input textures of all the materials assigned to the scene object are importance sampled. This mode can be useful when you explicitly want to vary the color texture according to a spatial projection based on the position of the instance such as world projections, texture switch or instance color for example. Please note that setting this mode while texturing Emission Color can lead to a degradation of the quality of the importance sampling if the intensity/weight component is encoded to the color textures. When Both, both Emission Color and Emission Weight input textures of all the materials assigned to the scene object are importance sampled. This mode should be used when using specific textures for Emission Color and Emission Weight.
object[] (Deformer) deformers VISUAL_HINT_DEFAULT List of deformation that will be applied on the geometry.
double smoothing_approximation VISUAL_HINT_PERCENTAGE Controls how much the smoothing must be approximated during the shading. This influences the origin of secondary rays casted from the surface. A value of 0% corresponds to the position that has been found during the raytracing and a value of 100% corresponds to the theoretical position on the smoothed surface.
long displacement_mode VISUAL_HINT_DEFAULT Control whether the displacement must compute bump, tessellation or both.
long displacement_storage_mode VISUAL_HINT_DEFAULT Define if displacement favors render time or memory used to generate it.
long displacement_tessellation_mode VISUAL_HINT_DEFAULT Control the generation of the tessellation used for the micro displacement. Adaptive modes try to compute the tessellation level according to the size of the primitives whereas the uniform mode generates the same tessellation on all primitives. For the adaptive modes, it is possible to choose if the tessellation level has to be computed on the base geometry or on the deformed one.
long displacement_adaptive_span_count VISUAL_HINT_DEFAULT Control the number of spans for the adaptive tessellation. This value corresponds to the number of spans on the bounding box of the geometry.
long displacement_uniform_span_count VISUAL_HINT_DEFAULT Control the number of spans for the uniform tessellation. This value corresponds to the number of spans on each primitive.
long displacement_triangulation_mode VISUAL_HINT_DEFAULT Define on which geometry the micro-facets triangulation is computed.
long displacement_stitching_mode VISUAL_HINT_DEFAULT Control the stitching between primitives. The stitching only affects values of the displacement so it doesn't work if the geometry has discontinuities on normals.
long smoothing_mode VISUAL_HINT_DEFAULT Define the normals that are used. If the mesh doesn't define any normal map or if a normal is not defined in the first normal map, the normal used is the one computed with the smoothing angle.
double smoothing_angle VISUAL_HINT_ANGLE Set the limit angle between two adjacent faces under which the edge is considered as smooth.
bool enable_subdivision_surface VISUAL_HINT_DEFAULT Enable the subdivision of the polygons that compose the mesh.
long subdivision_mode VISUAL_HINT_DEFAULT Choose wich mode to use to enable the subdivision of the polygons that compose the mesh.
long raytrace_mode VISUAL_HINT_DEFAULT Define how the subdivision is interpreted by the raytracer. A fixed tessellation generates a real mesh that is stored in memory. The tessellation on the fly generates the tessellation locally for each ray which avoids storing anything in memory. The evaluate surface mode tries to compute the exact intersection with the smooth surface (infinite tessellation). The fixed tessellation is usually faster than other modes but uses more memory.
long raytrace_tessellation_level VISUAL_HINT_DEFAULT Set the level of the tessellation. Higher it is, smaller the polygons are. This parameter has no effect when the raytrace mode is set on evaluate surface.
long geometry_interpolation VISUAL_HINT_DEFAULT Define how the interpolation of the vertices is done for the geometry. Here one can specify if the original vertices of the mesh should be smoothed or not. It is possible to disable the smoothing for all the vertices (linear), only for the vertices form the borders or only the corners.
long uv_interpolation VISUAL_HINT_DEFAULT Define how the interpolation of the vertices is done for the UV maps. Here one can specify if the original vertices of the mesh should be smoothed or not. It is possible to disable the smoothing for all the vertices (linear), only for the vertices form the borders or only the corners. It is also possible to control it along the discontinuities between the UV maps and the geometry.
long boundary_interpolation VISUAL_HINT_DEFAULT Controls how boundary edges and vertices are interpolated.
long property_interpolation VISUAL_HINT_DEFAULT Controls how the maps are interpolated.
long subdivision_level_mode VISUAL_HINT_DEFAULT Define the raytrace tessellation mode. 'Fixed' uses 'Raytrace Tessellation Level'. 'Use Property' reads the value of the property 'Subdivision Level Property' to set the tessellation level. Note this property must be set to a scalar type. If there isn't any valid property it falls back to the value set in 'Raytrace Tessellation Level'.
string subdivision_level_property VISUAL_HINT_TAG Set the level of tessellation using a scalar property.
long property_driven_subdivision_offset VISUAL_HINT_DEFAULT Increase or decrease the level of tessellation by this offset.
long property_driven_min_subdivision VISUAL_HINT_DEFAULT Set the minimum level of tessellation.
long property_driven_max_subdivision VISUAL_HINT_DEFAULT Set the max level of tessellation.
long crease_mode VISUAL_HINT_DEFAULT Define the algorithm use for the creases
bool activate_crease_driven_subdivision VISUAL_HINT_DEFAULT When activated, use the maximum crease level defined on the object to set the tessellation level. If no crease is defined, the tessellation level uses the scalar Subdivision Level Property if it exists otherwise it uses the value set in 'Raytrace Tessellation Level'.
long crease_driven_subdivision_offset VISUAL_HINT_DEFAULT Increase or decrease the level of tessellation by this offset.
long crease_driven_min_subdivision VISUAL_HINT_DEFAULT Set the minimum level of tessellation.
long crease_driven_max_subdivision VISUAL_HINT_DEFAULT Set the max level of tessellation.

## CID#

class "GeometryAbcMesh" "GeometryPolymesh" {
abstract yes
#version 0.99
icon "../icons/object_icons/geometry_mesh_abc.iconrc"
doc "Import an alembic mesh from a file. Supported format: abc."
attribute_group "alembic" {
list<filename_open> "filename" {
doc "File path."
extension "abc"
saveable no
value ""
}
list<string> "filename_sys" {
private yes
value ""
}
string "object_name" {
doc "Object path in file."
hidden yes
value ""
}
bool "valid_data" {
doc "this attribute stores the state of the object for a given filename/object name: when using \$F in the filename it can change"
private yes
saveable no
value yes
}
string "base_data_hash_key" {
private yes
dg_active no
value ""
}
string "data_hash_key" {
private yes
dg_active no
value ""
}
string "properties_hash_key" {
private yes
dg_active no
value ""
}
list<long> "data_hash_key_timestamp" {
doc "Files modificiation times."
private yes
value <empty>
}
}
attribute_group "alembic>playback" {
collapsed yes
long "pivot_mode" {
doc "Set the way pivot information is read in the file: using the baked matrix or individual attributes."
preset "Use Matrix" "0"
preset "Use Attributes" "1"
value 0
}
long "frame" {
doc "Defines the value of the frame that will be used to evaluate the mesh."
animatable yes
value[] 0
expression "F"
}
long "deformation_type" {
private yes
dg_active no
value 0
}
long "anim_frame_count" {
doc "Count of frames available in the file to animate the pivot"
dg_active no
value 1
}
long "deform_frame_count" {
doc "Count of frames available in the file to deform the geometry"
value 1
}
long "frame_offset" {
doc "Offset the time. If you set the value to 50 while the animation starts at frame 10, it then starts at frame 60."
animatable yes
ui_range yes -1000 1000
value 0
}
double "current_anim_time" {
doc "Time currently used. Attribute is set after time change"
private yes
saveable no
dg_active no
value 0.0
}
double[16] "base_matrix" {
doc "Base transformation matrix."
private yes
dg_active no
value 1 0.0 0.0 0.0 0.0 1 0.0 0.0 0.0 0.0 1 0.0 0.0 0.0 0.0 1
}
double[2] "anim_range" {
doc "Start and end time of the animation."
private yes
value 0.0 0.0
}
double[2] "deform_range" {
doc "Start and end time of the deformation."
private yes
value 0.0 0.0
}
long "animation_behavior" {
doc "Set how the animation will loop."
preset "Hold" "0"
preset "Repeat" "1"
value 0
}
bool "force_animation_range" {
value no
}
long[2] "animation_range" {
doc "Start and end of the forced animation."
value 0 50
}
long "deformation_behavior" {
doc "Set how the animation will be deformed."
preset "Hold" "0"
preset "Repeat" "1"
value 0
}
bool "force_deformation_range" {
value no
}
long[2] "deformation_range" {
doc "Start and end of the forced deformation."
value 0 50
}
long "visibility_type" {
private yes
dg_active no
value 0
}
double[2] "visibility_range" {
doc "Time range of the visibility property."
private yes
saveable no
dg_active no
value 0.0 0.0
}
}
ui_weight 1000
long "compression_mode" {
doc "Set whether data memory compression mode. Compression allows to save memory and should always be enabled. However in some very rare cases, it may slightly degrade the data. When this happens you can set the compression to Disable. If Compression is set to Automatic, compression is only performed if data degradation is minor. Automatic compression requires some extra processing which is why it is disabled by default."
preset "Disabled" "0"
preset "Enabled" "1"
preset "Automatic" "2"
value 1
}
}
attribute_group "motion_blur" {
long "motion_blur_mode" {
doc "Specify which data is used to compute motion blur. Read Velocities (distance per second): read velocities from file and interpret them as distance units per second. Read Velocities (distance per frame): read velocities from file and interpret them as distance units per frame. Compute Velocities: compute velocities from actual geometric positions. Use Sub Positions: use sub-frame geometric positions, providing more accurate results at the expense of more memory usage."
preset "Read Velocities (distance per second)" "0"
preset "Read Velocities (distance per frame)" "3"
preset "Compute Velocities" "1"
preset "Use Sub Positions" "2"
value 1
}
}
private yes
hidden no
saveable yes
texturable no
animatable no
slider no
numeric_range no 0.0 1
ui_range no 0.0 1
dg_active yes
dg_cyclic no
dirtiness_pass_through no
experimental no
overriden no
promote_attribute no
allow_expression yes
localizable yes
depends_on "filename_sys"
value <empty>
}
set "materials" {
filter "Material"
private no
hidden yes
saveable yes
texturable no
animatable no
slider no
numeric_range no 0.0 1
ui_range no 0.0 1
dg_active yes
dg_cyclic no
dirtiness_pass_through no
experimental no
overriden no
promote_attribute no
allow_expression yes
localizable yes
depends_on "filename_sys"
value <empty>
}
set "visibles" {
private no
hidden yes
saveable yes
texturable no
animatable no
slider no
numeric_range no 0.0 1
ui_range no 0.0 1
dg_active yes
dg_cyclic no
dirtiness_pass_through no